Awesome Open Source
Awesome Open Source

Beautiful Notification Toasts For Laravel

A Toast global that can be called from the backend (via Controllers, Blade Views, Components) or frontend (JS, Alpine Components) to render customizable toasts.

Runs with the TALL stack: Laravel, TailwindCSS, Livewire, AlpineJS.

GitHub tag (latest SemVer) Build size Brotli
Scrutinizer Score Codacy branch grade
Styling Tests & Checks Codecov branch

Light Dark
toast-light toast-dark

Why

If you are building a web app with the TALL stack, you must choose this library over the other outdated libraries available:

Size does matter

Since the frontend is a pure AlpineJS component with no reliance on external JS libs, and since the backend handles most of the logic, the javascript footprint is tiny (less than ONE kilobyte!) .

The CSS footprint is also negligible as it uses the default TailwindCSS classes. Even if you override the default views, you will rest assured that Tailwind's purging will only keep the styles/classes you have used.

In plain English, it will not bloat your generated JS/CSS files nor add extra files to download as when using other JS libs!

Takes advantage of all the niceties that come with TALL

You can call it from anywhere! Memorize Toast for the frontend and toast() for the backend.

See the usage section for examples.

Customizable

You have control over the view: As you are overriding the blade view, you'll be able to shape it as you like using TailwindCSS classes.

No more messing with custom CSS overrides!

Usage

From The Frontend

Toast.info('Notification from the front-end...', 'The Title');

Toast.success('A toast without a title also works');

Toast.warning('Watch out!');

Toast.danger('I warned you!', 'Yikes');

Toast.debug('I will NOT show in production! Locally, I will also log in console...', 'A Debug Message');

From The Backend

toast()
    ->info('I will appear only on the next page!')
    ->pushOnNextPage();

toast()
    ->info('Notification from the backend...', 'The Title')
    ->push();

toast()
    ->success('A toast without a title also works')
    ->push();

toast()
    ->warning('Watch out!')
    ->push();

toast()
    ->danger('I warned you!', 'Yikes')
    ->push();

toast()
    ->danger('I will go<br><i>to the next line </i>', 'I am <span style="color:red;">HOT</span>')
    ->doNotSanitize()
    ->push();

toast()
    ->debug('I will NOT show in production! Locally, I will also log in console...', 'A Debug Message')
    ->push();

// debug also accepts objects as message
toast()
    ->debug(User::factory()->createOne()->only(['name', 'email']), 'A User Dump')
    ->push();

You can call the above toast helper from controllers, blade views, and components.

To properly call it from inside livewire components, add the trait:

use Livewire\Component;
use Usernotnull\Toast\Concerns\WireToast;

class DemoComponent extends Component
{
    use WireToast; // <-- add this

    public function sendCookie(): void
    {
        toast()
            ->success('You earned a cookie! ')
            ->pushOnNextPage();

        redirect()->route('dashboard');
    }

Video tutorial and walk-through coming soon!

Support Me

I plan on developing many open-source packages using the TALL stack.
Consider supporting my work by tweeting about this library or by contributing to this package.

Check out the list of other packages I built for the TALL stack Other Packages.
To stay updated, follow me on Twitter.

Requirements

Dependency Version Comment
PHP ^8.0 Make the switch, you won't regret it :)
Laravel ^8.0 Official Installation Docs
TailwindCSS ^2.0 Official Installation Docs
Livewire ^2.0 Official Installation Docs
AlpineJS ^3.0 Official Installation Docs

Installation

You can install the package via Composer:

composer require usernotnull/tall-toasts

Setup

TailwindCSS

Build your CSS as you usually do, ie

npm run dev

Usage With Tailwind JIT

If you are using Just-in-Time Mode, add these additional lines into your tailwind.config.js file:

purge: [
    './vendor/usernotnull/tall-toasts/config/**/*.php',
    './vendor/usernotnull/tall-toasts/resources/views/**/*.blade.php',
    // etc...
]

This way, Tailwind JIT will include the classes used in this library in your CSS.

As usual, if the content of tailwind.config.js changes, you should re-run the npm command.

AlpineJS

Add the ToastComponent to AlpineJS either as an npm module or with a script tag.

Option 1: NPM Module

Add the AlpineJS Toast component by changing your app.js file to match:

import Alpine from "alpinejs"
import ToastComponent from '../../vendor/usernotnull/tall-toasts/dist/js/tall-toasts'

Alpine.data('ToastComponent', ToastComponent)

window.Alpine = Alpine
Alpine.start()

If you have a custom directory structure, you may have to adjust the above import path until it correctly points to tall-toasts.js inside this vendor file.

Option 2: Script Tag

Add the @toastScripts blade directive BEFORE importing AlpineJS:

  • If you imported AlpineJS from a script tag:
@toastScripts
<script src="https://unpkg.com/[email protected]/dist/cdn.min.js" defer></script>
  • If you installed AlpineJS as an NPM Module:
@toastScripts
<script src="{{ mix('js/app.js') }}" defer></script>

The View

Add <livewire:toasts /> as high as possible in the body tag, ie:

<!DOCTYPE html>
<html lang="en">

<head>
    <!-- Metas, Styles, JS... -->
</head>

<body>
    <livewire:toasts />

    <!-- Below toasts, your contents... -->
</body>

</html>

That's it!


Customization

The toasts should look pretty good out of the box. However, we've documented a couple of ways to customize the views and functionality.

Configuration

You can publish the config file with:

php artisan vendor:publish --provider="Usernotnull\Toast\ToastServiceProvider" --tag="tall-toasts-config"

These are the default contents of the published config file:

<?php

return [
    /*
     * How long each toast will be displayed before fading out, in ms
     */
    'duration' => 5000,

    /*
     * How long to wait before displaying the toasts after page loads, in ms
     */
    'load_delay' => 400,
];

Customizing views

You can publish and change all views in this package:

php artisan vendor:publish --provider="Usernotnull\Toast\ToastServiceProvider" --tag="tall-toasts-views"

The published views can be found and changed in resources/views/vendor/tall-toast/.

The published files are:

  • includes/content.blade.php - the content view of each popup notification, fully configurable
  • includes/icon.blade.php - the icons of each notification type
  • livewire/toasts.blade.php - the parent of all toasts

Text Sanitization

The content view displays the title and message with x-html. This is fine since the backend sanitizes the title and message by default.

If you wish to skip sanitization in order to display HTML content, such as bolding the text or adding <br> to go to the next line, you will call doNotSanitize() as seen in the usage section. In such case, make sure no user input is provided!

Troubleshooting

Make sure you thoroughly go through this readme first!

If the checklist below does not resolve your problem, feel free to submit an issue. Make sure to follow the bug report template. It helps us quickly reproduce the bug and resolve it.

The toasts show multiple times only after refresh

  • If you are calling toasts from a livewire component, did you add the trait WireToast to the component? (see)

  • Did you swap push() and pushOnNextPage()?

The toasts won't show

  • Is the <livewire:toasts /> located in a page that has both the livewire and alpine/app.js script tags inserted? (see)

  • Did you skip adding the ToastComponent as an alpine data component? (see)

  • Did you forget calling push() at the end of the chained method? (see)

  • Have you tried calling the toast() helper function from another part of the application and check if it worked (it will help us scope the problem)? (see)

  • Did you try calling php artisan view:clear?

  • Are you getting any console errors?

The toasts show but look weird

  • Are you using TailwindCSS JIT? Don't forget to update your purge list! (see)
  • You may need to rebuild your CSS by running: npm run dev or re-running npm run watch (see)

Other Packages

  • TALL Floating Action Menu (unreleased)
  • TALL Package Skeleton (unreleased)

To stay updated, follow me on Twitter.

Testing

This package uses PestPHP to run its tests.

  • To run tests without coverage, run:
composer test
  • To run tests with coverage, run:
composer test-coverage

Contributing

This package has 3 GitHub Workflows which run sequentially when pushing PRs:

When pushing PRs, it's a good idea to do a quick run and make sure the workflow checks out, which saves time during code review before merging.

To facilitate the job, you can run the below command before pushing the PR:

composer workflow

Please see CONTRIBUTING for details.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Versioning

This project follows the Semantic Versioning guidelines.

Security Vulnerabilities

As per security best practices, do not call doNotSanitize() on a toast that has user input in its message or title!

Please review the security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see the license file for more information.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Php (394,997
Laravel (13,232
Tailwindcss (4,547
Notifications (2,716
Laravel Package (1,093
Toast (510
Alpinejs (201
Livewire (180
Toast Notifications (113
Livewire Components (17
Related Projects