To start, make sure the package is installed - @livewire('notifications') should be in your Blade layout somewhere.
Notifications are sent using a Notification object that’s constructed through a fluent API. Calling the send() method on the Notification object will dispatch the notification and display it in your application. As the session is used to flash notifications, they can be sent from anywhere in your code, including JavaScript, not just Livewire components.
Title
The main message of the notification is shown in the title. You can set the title as follows:Icon
Optionally, a notification can have an icon that’s displayed in front of its content. You may also set a color for the icon, which defaults to thesecondary color specified in your tailwind.config.js file. The icon can be the name of any Blade component. By default, the Blade Heroicons v1 package is installed, so you may use the name of any Heroicons v1 out of the box. However, you may create your own custom icon components or install an alternative library if you wish.
Notifications often have a status like success, warning or danger. Instead of manually setting the corresponding icons and colors, there’s a status() method which you can pass the status. You may also use the dedicated success(), warning() and danger() methods instead. So, cleaning up the above example would look like this:
Duration
By default, notifications are shown for 6 seconds before they’re automatically closed. You may specify a custom duration value in milliseconds as follows:Body
Additional notification text can be shown in the body. Similar to the title, it supports Markdown:
Actions
Notifications support actions that render a button or link which may open a URL or emit a Livewire event. Actions will render as link by default, but you may configure it to render a button using thebutton() method. Actions can be defined as follows:
Opening URLs
If clicking on an action should open a URL, optionally in a new tab, you can do so:Emitting events
Sometimes you want to execute additional code when a notification action is clicked. This can be achieved by setting a Livewire event which should be emitted on clicking the action. You may optionally pass an array of data, which will be available as parameters in the event listener on your Livewire component:emitSelf, emitUp and emitTo:
emitSelf, emitUp and emitTo are also available:
Closing notifications
After opening a URL or emitting an event from your action, you may want to close the notification right away:Using the JavaScript objects
The JavaScript objects (Notification and NotificationAction) are assigned to window.Notification and window.NotificationAction, so they are available in on-page scripts.
You may also import them in a bundled JavaScript file: