Laravel Notify

https://github.com/mckenziearts/laravel-notify
Admin
Laravel Notify is a lightweight Laravel package for displaying backend-driven notifications in your...
Tokens:25,800
Snippets:222
Trust Score:9.2
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### info() usage example

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Example of using info() to show an informational notification.

```php
notify()
    ->info()
    ->title('A new version is available')
    ->send();
```

--------------------------------

### icon() usage example

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Example of using icon() with a custom icon name.

```php
notify()
    ->success()
    ->title('Welcome back')
    ->icon('untitledui-user-check')
    ->send();
```

--------------------------------

### Navigation action with URL

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Example of a navigation action with a URL.

```php
NotifyAction::make()
    ->label('View details')
    ->url(route('users.show', $user->id));
```

--------------------------------

### Setting label and action

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Example of setting a label and an action URL for an execution action.

```php
NotifyAction::make()
    ->label('Undo')
    ->action(route('users.restore', $user->id));
```

--------------------------------

### title() usage example

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Example of using title() with a success notification.

```php
notify()
    ->success()
    ->title('Saved successfully')
    ->send();
```

--------------------------------

### Usage example of notify()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/helpers.md

Example of using notify() to send a success notification with a title.

```php
notify()
    ->success()
    ->title('Laravel Notify is awesome!')
    ->send();
```

--------------------------------

### Layout example with Blade directives

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-service-provider.md

Example HTML layout using @notifyCss, <x-notify::notify />, and @notifyJs to render notifications.

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Laravel Notify</title>

    @notifyCss
</head>
<body>

    <x-notify::notify />

    @notifyJs
</body>
</html>
```

--------------------------------

### Import Alpine.js in app.js

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Import Alpine.js and start it in your resources/js/app.js file.

```javascript
import Alpine from 'alpinejs'
window.Alpine = Alpine
Alpine.start()
```

--------------------------------

### openUrlInNewTab() usage example

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Creates a URL action that opens in a new tab, with an explicit opt-out example. The boolean argument allows disabling the behavior.

```php
NotifyAction::make()
    ->label('Read documentation')
    ->url('https://laravel.com/docs')
    ->openUrlInNewTab();

// opt out explicitly:
NotifyAction::make()
    ->label('Read documentation')
    ->url('https://laravel.com/docs')
    ->openUrlInNewTab(false);
```

--------------------------------

### Install Laravel Notify via Composer

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Use Composer to install the mckenziearts/laravel-notify package.

```bash
composer require mckenziearts/laravel-notify
```

--------------------------------

### Complete example with actions

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Full controller method showing a delete notification with undo and view trash actions. Includes method and openUrlInNewTab usage.

```php
public function destroy(User $user)
{
    $user->delete();

    notify()
        ->success()
        ->title('User deleted')
        ->message('The user has been moved to trash')
        ->actions([
            NotifyAction::make()
                ->label('Undo')
                ->action(route('users.restore', $user->id))
                ->method('POST'),
            NotifyAction::make()
                ->label('View Trash')
                ->url(route('users.trash'))
                ->openUrlInNewTab(),
        ])
        ->send();

    return redirect()->route('users.index');
}
```

--------------------------------

### Execution action with POST method

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Example of an execution action with an explicit POST method.

```php
NotifyAction::make()
    ->label('Restore')
    ->action(route('users.restore', $user->id))
    ->method('POST');
```

--------------------------------

### warning() usage example

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Example of using warning() with a custom duration to keep the notification open until manually closed.

```php
notify()
    ->warning()
    ->title('Your session is about to expire')
    ->duration(999999) // stay open until manually closed
    ->send();
```

--------------------------------

### Creating a NotifyAction instance

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Example of creating a new NotifyAction instance using the static make() factory.

```php
$action = NotifyAction::make();
```

--------------------------------

### Execution action with DELETE and custom classes

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Example of an execution action with DELETE method and custom CSS classes.

```php
NotifyAction::make()
    ->label('Delete')
    ->action(route('users.delete', $user->id))
    ->method('DELETE')
    ->classes('text-red-600 hover:text-red-500 font-bold');
```

--------------------------------

### error() usage example

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Example of using error() to show an error notification with a title and message.

```php
notify()
    ->error()
    ->title('Something went wrong')
    ->message('The payment could not be processed.')
    ->send();
```

--------------------------------

### Branch rendering based on action kind

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Example of using hasUrl() to branch between navigation and execution actions. The getUrl() method is called only when a URL is set.

```php
$action = NotifyAction::make()
    ->label('View')
    ->url('https://example.com');

if ($action->hasUrl()) {
    // navigation action
    echo $action->getUrl();
}
```

--------------------------------

### getMessage() usage example

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Retrieves the flashed notification message, returning a string or null.

```php
$message = notify()->getMessage(); // string|null
```

--------------------------------

### url()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Configures the action as a navigation action, rendering the button as a plain link. This is a GET request with no JavaScript.

```APIDOC
## url()

### Description
Makes this a navigation action: the button is rendered as a plain <a href="..."> link (GET, no JavaScript).

### Method
url

### Signature
`public function url(string $url): self`

### Parameters
- **$url** (string) - Required - Destination URL (typically route(...) or an absolute URL).

### Returns
- **self** - Returns the current NotifyAction instance for chaining.

### Throws
- **InvalidNotificationException** - If action() was already called on this instance.

### Example
```php
NotifyAction::make()
    ->label('View details')
    ->url(route('users.show', $user->id));
```
```

--------------------------------

### toArray() usage example

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Creates a URL action and converts it to an array. The output shows the array structure with method set to null and openUrlInNewTab set to true.

```php
$array = NotifyAction::make()
    ->label('View Details')
    ->url('https://example.com')
    ->openUrlInNewTab()
    ->classes('text-blue-600')
    ->toArray();

// [
//   'label' => 'View Details',
//   'url' => 'https://example.com',
//   'action' => null,
//   'classes' => 'text-blue-600',
//   'method' => null,
//   'openUrlInNewTab' => true,
// ]
```

--------------------------------

### success() usage in controller

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Example of using success() in a controller's store method to show a success notification after storing a resource.

```php
public function store()
{
    // store the resource ...

    notify()
        ->success()
        ->title('⚡️ Laravel Notify is awesome!')
        ->send();

    return back();
}
```

--------------------------------

### model() usage with Smiley

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Example of using model() with NotificationModel::Smiley to show a smiley notification.

```php
use Mckenziearts\Notify\Enums\NotificationModel;

notify()
    ->model(NotificationModel::Smiley)
    ->success()
    ->title('You are successfully reconnected')
    ->send();
```

--------------------------------

### Custom duration example

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Sets a custom duration of 3000 milliseconds (3 seconds) for the notification.

```php
notify()
    ->success()
    ->title('Saved successfully')
    ->duration(3000) // 3 seconds
    ->send();
```

--------------------------------

### Drakify notification (success and error)

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Displays an alert only. Shows both success and error examples in one block.

```php
// For success alert
notify()
    ->model(NotificationModel::Drake)
    ->success()
    ->send();
// or
notify()
    ->model(NotificationModel::Drake)
    ->error()
    ->send(); // for error alert
```

--------------------------------

### Blade usage of notifyJs()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/helpers.md

Example of using notifyJs() in a Blade template to output the script tag.

```blade
{!! notifyJs() !!}
```

--------------------------------

### method() usage example

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Creates an execution action with a DELETE HTTP method. The method is normalized to uppercase. Throws InvalidNotificationException if the action already has a URL.

```php
NotifyAction::make()
    ->label('Delete permanently')
    ->action(route('users.force-delete', $user->id))
    ->method('DELETE');
```

--------------------------------

### getType() usage example

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Retrieves the flashed notification type and checks if it equals NotificationType::Success.

```php
$type = notify()->getType(); // NotificationType|null

if ($type === NotificationType::Success) {
    // ...
}
```

--------------------------------

### Layout example with @notifyCss and @notifyJs

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/blade-components.md

Use this HTML layout to include the notification CSS in the head and the notification component and JavaScript before the closing body tag. This is the Tailwind-free path for rendering notifications.

```html
<head>
    @notifyCss
</head>
<body>
    <x-notify::notify />
    @notifyJs
</body>
```

--------------------------------

### Blade usage of notifyCss()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/helpers.md

Example of using notifyCss() in a Blade template to output the link tag.

```blade
{!! notifyCss() !!}
```

--------------------------------

### Long duration example

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Sets a very long duration (999999 ms, ~16 minutes) to keep the notification open until manually closed.

```php
notify()
    ->warning()
    ->title('Important notice')
    ->duration(999999) // ~16 minutes
    ->send();
```

--------------------------------

### model() usage with Drake

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Example of using model() with NotificationModel::Drake, which renders an image-only alert and forbids message, title, and actions.

```php
notify()
    ->model(NotificationModel::Drake)
    ->error()
    ->send();
```

--------------------------------

### send() error handling example

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Catches InvalidNotificationException when using the Drake model with a title, logging the error message.

```php
use Mckenziearts\Notify\Exceptions\InvalidNotificationException;

try {
    notify()
        ->model(NotificationModel::Drake)
        ->title('This is forbidden')
        ->send();
} catch (InvalidNotificationException $e) {
    // $e->getMessage() === 'The Drake notification cannot have a title...'
    report($e);
}
```

--------------------------------

### NotifyAction::url() method

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Makes this a navigation action: the button is rendered as a plain <a href="..."> link (GET, no JavaScript). Throws InvalidNotificationException if action() was already called.

```php
public function url(string $url): self
```

--------------------------------

### Override preset notification values

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Overrides values of a preset notification by passing an array of key-value pairs. Example overrides the 'title' attribute.

```php
notify()->preset('common-notification', ['title' => 'This is the overridden title'])->send();
```

--------------------------------

### DirectionHelper class source code

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/types.md

The DirectionHelper class is a static utility that resolves the notification direction. It defines a list of RTL locale prefixes and provides methods to check if the current locale is RTL and to get the direction string. The class is used in the notification wrapper blade view to set the dir attribute.

```php
<?php

declare(strict_types=1);

namespace Mckenziearts\Notify\Helpers;

class DirectionHelper
{
    /** @var array<int, string> */
    protected static array $rtlLocales = [
        'ar', // Arabic
        'he', // Hebrew
        'fa', // Persian/Farsi
        'ur', // Urdu
        'yi', // Yiddish
        'ji', // Yiddish (alternative code)
        'iw', // Hebrew (alternative code)
        'dv', // Dhivehi
        'ku', // Kurdish (Sorani)
    ];

    public static function isRtl(): bool
    public static function getDirection(): string
}
```

--------------------------------

### Build assets with npm

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Build your assets using npm run build or npm run dev for development.

```bash
npm run build
# or for development
npm run dev
```

--------------------------------

### boot() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-service-provider.md

The boot method performs boot-time wiring: registers Blade directives, publishes assets/config/lang, loads views and translations.

```php
public function boot(): void
```

--------------------------------

### bootPublishes() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-service-provider.md

Registers three publish groups for vendor:publish.

```php
public function bootPublishes(): void
```

--------------------------------

### Publish commands for assets, config, and lang

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-service-provider.md

Commands to publish the package's assets, config, and language files.

```bash
php artisan vendor:publish --tag=notify-assets
php artisan vendor:publish --tag=notify-config
php artisan vendor:publish --tag=notify-lang # optional, to customize translations
```

--------------------------------

### register() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-service-provider.md

The register method merges config and registers the 'notify' singleton.

```php
public function register(): void
```

--------------------------------

### action()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Configures the action as an execution action, sending an HTTP request to the given URL. The button is rendered as a <button> with a fetch() handler.

```APIDOC
## action()

### Description
Makes this an execution action: the button sends an HTTP request to the given URL (POST by default, configurable with method()). Rendered as a <button> with an Alpine fetch() handler.

### Method
action

### Signature
`public function action(string $action): self`

### Parameters
- **$action** (string) - Required - URL that receives the request (typically route(...)).

### Returns
- **self** - Returns the current NotifyAction instance for chaining.

### Throws
- **InvalidNotificationException** - If url() was already called on this instance.

### Example
```php
NotifyAction::make()
    ->label('Restore')
    ->action(route('users.restore', $user->id))
    ->method('POST');
```
```

--------------------------------

### Complete source of src/helpers.php

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/helpers.md

The full source file defining the three global helper functions: notify(), notifyJs(), and notifyCss(). Each is wrapped in function_exists() checks to prevent redeclaration.

```php
<?php

use Mckenziearts\Notify\Notify;

if (! function_exists('notify')) {
    function notify(): Notify
    {
        /** @var Notify $notify */
        $notify = app('notify');

        return $notify;
    }
}

if (! function_exists('notifyJs')) {
    function notifyJs(): string
    {
        return '<script type="text/javascript" src="'.asset('vendor/mckenziearts/laravel-notify/dist/notify.js').'"></script>';
    }
}

if (! function_exists('notifyCss')) {
    function notifyCss(): string
    {
        return '<link rel="stylesheet" type="text/css" href="'.asset('vendor/mckenziearts/laravel-notify/dist/notify.css').'"/>';
    }
}
```

--------------------------------

### Basic preset usage

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Sends a notification using the 'success' preset with no overrides.

```php
notify()->preset('success')->send();
```

--------------------------------

### make()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Static factory method to create a new NotifyAction instance. This is the only way to instantiate the class since the constructor is private.

```APIDOC
## make()

### Description
Creates a new NotifyAction instance with default property values.

### Method
make

### Signature
`public static function make(): self`

### Parameters
None.

### Returns
- **self** - A new NotifyAction instance.

### Example
```php
$action = NotifyAction::make();
```
```

--------------------------------

### Open URL in new tab with openUrlInNewTab()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Opens the URL in a new tab. Can only be used with url(); using it with action() throws an exception.

```php
NotifyAction::make()
    ->label('Read documentation')
    ->url('https://laravel.com/docs')
    ->openUrlInNewTab();
```

--------------------------------

### Catch missing preset exception

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Wraps preset() in a try-catch to handle MissingPresetNotificationException when the preset does not exist.

```php
use Mckenziearts\Notify\Exceptions\MissingPresetNotificationException;

try {
    notify()->preset('common-notification')->send();
} catch (MissingPresetNotificationException $e) {
    Log::warning($e->getMessage());
}
```

--------------------------------

### Constructor

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Creates a new Notify instance. The constructor requires an Illuminate\Session\Store instance, which is normally injected automatically by the container when resolving the singleton.

```APIDOC
## Constructor

### Description
Creates a new Notify instance. The constructor requires an Illuminate\Session\Store instance, which is normally injected automatically by the container when resolving the singleton.

### Method
Constructor

### Signature
```php
public function __construct(
    private readonly Store $session
) {}
```

### Parameters
- **$session** (Illuminate\Session\Store) - Required - The Laravel session store used to flash() the notification payload under the 'notify' key.
```

--------------------------------

### openUrlInNewTab()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Configures URL actions to open in a new tab with target="_blank" rel="noopener noreferrer". Allows explicit opt-out via a boolean parameter.

```APIDOC
## openUrlInNewTab()

### Description
For URL actions: renders the link with `target="_blank" rel="noopener noreferrer"`. The boolean argument allows explicit opt-out.

### Method
`public function openUrlInNewTab(bool $openInNewTab = true): self`

### Parameters
- **$openInNewTab** (bool) - Optional - Default: `true` - Whether the link opens in a new tab.

### Throws
`InvalidNotificationException` when called on an action that already has an `action()` ("The openUrlInNewTab() function can only be used with url(), not with action().").

### Examples
```php
NotifyAction::make()
    ->label('Read documentation')
    ->url('https://laravel.com/docs')
    ->openUrlInNewTab();

// opt out explicitly:
NotifyAction::make()
    ->label('Read documentation')
    ->url('https://laravel.com/docs')
    ->openUrlInNewTab(false);
```

### Source
`src/Action/NotifyAction.php:83`.
```

--------------------------------

### Singleton registration for Notify

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-service-provider.md

Registers a singleton under 'notify' that resolves a Notify instance. Requires a session to be available.

```php
$this->app->singleton('notify', fn (Application $app): Notify => $app->make(Notify::class));
```

--------------------------------

### Publish config file with artisan vendor:publish

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/configuration.md

Publishes the configuration file to config/notify.php using the notify-config tag. Run this command to customize the package settings.

```bash
php artisan vendor:publish --tag=notify-config
```

--------------------------------

### Specify HTTP method with method()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Sets the HTTP method for an action request. Can only be used with action(); using it with url() throws an exception. Defaults to POST if not specified.

```php
// DELETE request
NotifyAction::make()
    ->label('Delete permanently')
    ->action(route('users.force-delete', $user->id))
    ->method('DELETE');

// PUT request
NotifyAction::make()
    ->label('Update status')
    ->action(route('users.activate', $user->id))
    ->method('PUT');
```

--------------------------------

### info()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Sets the notification type to info. Returns the builder instance for chaining.

```APIDOC
## info()

### Description
Sets the notification type to `info`. Returns `$this` for chaining.

### Method
info

### Signature
`public function info(): self`

### Parameters
None

### Returns
- `self` - The builder instance for chaining.

### Example
```php
notify()
    ->info()
    ->title('A new version is available')
    ->send();
```
```

--------------------------------

### warning()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Sets the notification type to warning. Returns the builder instance for chaining.

```APIDOC
## warning()

### Description
Sets the notification type to `warning`. Returns `$this` for chaining.

### Method
warning

### Signature
`public function warning(): self`

### Parameters
None

### Returns
- `self` - The builder instance for chaining.

### Example
```php
notify()
    ->warning()
    ->title('Your session is about to expire')
    ->duration(999999) // stay open until manually closed
    ->send();
```
```

--------------------------------

### Use preset notifications with Notify::preset()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/configuration.md

Shows how to trigger a preset notification by name and optionally override fields like title. A missing preset name throws MissingPresetNotificationException.

```php
notify()->preset('user-updated')->send();
// override one field in place:
notify()->preset('user-updated', ['title' => 'Custom title'])->send();
```

--------------------------------

### toArray()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Serializes the action for session storage. Returns an array with label, url, action, classes, method, and openUrlInNewTab keys, with method defaulting to 'POST' for execution actions.

```APIDOC
## toArray()

### Description
Serializes the action for session storage (called from `Notify::send()`).

### Method
`public function toArray(): array`

### Return Value
Returns an array with the following structure:
```php
[
    'label' => ?string,
    'url' => ?string,
    'action' => ?string,
    'classes' => ?string,
    'method' => $this->action !== null ? ($this->method ?? 'POST') : null,
    'openUrlInNewTab' => bool,
]
```

### Behavioral Details
- `method` is only emitted for execution actions, and defaults to `'POST'` for them (the `?? 'POST'` fallback).
- `openUrlInNewTab` is always emitted as a `bool`.

### Example
```php
$array = NotifyAction::make()
    ->label('View Details')
    ->url('https://example.com')
    ->openUrlInNewTab()
    ->classes('text-blue-600')
    ->toArray();

// [
//   'label' => 'View Details',
//   'url' => 'https://example.com',
//   'action' => null,
//   'classes' => 'text-blue-600',
//   'method' => null,
//   'openUrlInNewTab' => true,
// ]
```

### Source
`src/Action/NotifyAction.php:139`.
```

--------------------------------

### actions() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Declares the actions() method that accepts an array of NotifyAction instances and returns the builder instance.

```php
/**
 * @param  array<int, NotifyAction>  $actions
 */
public function actions(array $actions): self
```

--------------------------------

### notify() function implementation

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/helpers.md

The implementation of notify() that resolves the 'notify' container singleton and returns it.

```php
function notify(): Notify
{
    /** @var Notify $notify */
    $notify = app('notify');

    return $notify;
}
```

--------------------------------

### model() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Method signature for model(). Sets the notification visual model, defaulting to NotificationModel::Toast.

```php
public function model(NotificationModel $model): self
```

--------------------------------

### preset() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Declares the preset() method that loads a preset message from config('notify.preset-messages'). Accepts a preset name and optional override values, returning $this for chaining.

```php
/**
 * Return a preset message that is defined in the config file
 *
 * @param  array<string, mixed>  $overrideValues
 *
 * @throws Exception
 */
public function preset(string $presetName, array $overrideValues = []): self
```

--------------------------------

### Action action with action() method

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Executes a controller action via an HTTP request (POST by default). Use the action() method on NotifyAction.

```php
NotifyAction::make()
    ->label('Restore')
    ->action(route('users.restore', $user->id));
```

--------------------------------

### Basic usage in controller

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Call the notify() method with success() and title() before a redirect. The send() method triggers the notification.

```php
public function store()
{
    notify()
        ->success()
        ->title('⚡️ Laravel Notify is awesome!')
        ->send();

    return back();
}
```

--------------------------------

### success()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Sets the notification type to success. Returns the builder instance for chaining.

```APIDOC
## success()

### Description
Sets the notification type to `success`. Returns `$this` for chaining.

### Method
success

### Signature
`public function success(): self`

### Parameters
None

### Returns
- `self` - The builder instance for chaining.

### Example
```php
notify()
    ->success()
    ->title('⚡️ Laravel Notify is awesome!')
    ->send();
```
```

--------------------------------

### model(NotificationModel $model)

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Sets the notification visual model. Returns the builder instance for chaining.

```APIDOC
## model(NotificationModel $model)

### Description
Sets the notification visual model. The default is `NotificationModel::Toast`. Returns `$this` for chaining.

### Method
model

### Signature
`public function model(NotificationModel $model): self`

### Parameters
#### Parameters
- **$model** (NotificationModel) - Required - One of `Toast`, `Connect`, `Smiley`, `Emotify`, `Drake`.

### Returns
- `self` - The builder instance for chaining.

### Example
```php
use Mckenziearts\Notify\Enums\NotificationModel;

notify()
    ->model(NotificationModel::Smiley)
    ->success()
    ->title('You are successfully reconnected')
    ->send();
```

### Notes
- The `Drake` model renders an image-only alert; message, title, and actions are forbidden.

```php
notify()
    ->model(NotificationModel::Drake)
    ->error()
    ->send();
```
```

--------------------------------

### Notify constructor with session parameter

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

The constructor requires an Illuminate\Session\Store instance, which is injected automatically by the container. It is used to flash the notification payload under the 'notify' key. Direct construction is only needed for testing.

```php
public function __construct(
    private readonly Store $session
) {}
```

--------------------------------

### Publish Laravel Notify assets and config

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Publish the package's assets and configuration files using the artisan vendor:publish command with the notify-assets and notify-config tags.

```bash
php artisan vendor:publish --tag=notify-assets
php artisan vendor:publish --tag=notify-config
```

--------------------------------

### title(string $title)

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Sets the headline text. Returns the builder instance for chaining.

```APIDOC
## title(string $title)

### Description
Sets the headline text. If not set, `send()` uses `NotificationType::getDefaultTitle()`. For `NotificationModel::Drake`, the title is always stored as `null` and calling `title()` before `send()` throws `InvalidNotificationException`. Returns `$this` for chaining.

### Method
title

### Signature
`public function title(string $title): self`

### Parameters
#### Parameters
- **$title** (string) - Required - Headline text of the notification.

### Returns
- `self` - The builder instance for chaining.

### Example
```php
notify()
    ->success()
    ->title('Saved successfully')
    ->send();
```
```

--------------------------------

### message(string $message)

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Sets the message body text. Returns the builder instance for chaining.

```APIDOC
## message(string $message)

### Description
Sets the message body text shown below the title. Returns `$this` for chaining.

### Method
message

### Signature
`public function message(string $message): self`

### Parameters
#### Parameters
- **$message** (string) - Required - Body text of the notification.

### Returns
- `self` - The builder instance for chaining.

### Example
```php
notify()
    ->model(NotificationModel::Connect)
    ->success()
    ->title('Connection Found')
    ->message('Success Message Here')
    ->send();
```
```

--------------------------------

### duration() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Declares the duration() method that accepts an integer milliseconds value and returns the builder instance for chaining.

```php
public function duration(int $duration): self
```

--------------------------------

### method()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Sets the HTTP method for an execution action. The value is normalized to uppercase. Throws an exception if used with a URL action.

```APIDOC
## method()

### Description
Sets the HTTP method used for an execution action. The value is normalized with `strtoupper()` (so `'delete'` becomes `'DELETE'`). Only meaningful for `action()` actions; `toArray()` reports `method` as `null` for URL actions regardless.

### Method
`public function method(string $method): self`

### Parameters
- **$method** (string) - Required - HTTP verb, e.g. `'POST'`, `'PUT'`, `'DELETE'`.

### Throws
`InvalidNotificationException` when called on an action that already has a `url()` ("The method() function can only be used with action(), not with url().").

### Example
```php
NotifyAction::make()
    ->label('Delete permanently')
    ->action(route('users.force-delete', $user->id))
    ->method('DELETE');
```

### Source
`src/Action/NotifyAction.php:70`.
```

--------------------------------

### Getter method signatures

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Declares the getter methods for retrieving action properties. These return null when unset, except shouldOpenUrlInNewTab() which returns false by default.

```php
public function getLabel(): ?string
public function getUrl(): ?string
public function getAction(): ?string
public function getClasses(): ?string
public function getMethod(): ?string
public function shouldOpenUrlInNewTab(): bool
public function hasUrl(): bool
public function hasAction(): bool
```

--------------------------------

### info() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Method signature for info(). Sets the notification type to 'info' and returns $this. Info is the fallback type when no type is set.

```php
public function info(): self
```

--------------------------------

### NotifyAction::make() static factory

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Static factory method that is the only way to instantiate NotifyAction since the constructor is private. Returns a new instance with all properties at their defaults.

```php
public static function make(): self
```

--------------------------------

### icon() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Method signature for icon(). Sets a custom icon name for the notification.

```php
public function icon(string $icon): self
```

--------------------------------

### notify() function signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/helpers.md

The signature of the notify() helper function, which returns a Notify instance.

```php
function notify(): Notify
```

--------------------------------

### Define custom preset messages in config/notify.php

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/configuration.md

Shows how to define custom preset messages in the preset-messages array. Each preset uses enum instances for type and model, and accepts optional title, message, and duration fields.

```php
use Mckenziearts\Notify\Enums\NotificationType;
use Mckenziearts\Notify\Enums\NotificationModel;

'preset-messages' => [
    'user-updated' => [
        'type'    => NotificationType::Success,
        'model'   => NotificationModel::Toast,
        'title'   => 'User Updated',
        'message' => 'The user has been updated successfully.',
    ],
    'user-deleted' => [
        'type'    => NotificationType::Success,
        'model'   => NotificationModel::Toast,
        'title'   => 'User Deleted',
        'message' => 'The user has been deleted successfully.',
    ],
],
```

--------------------------------

### icon(string $icon)

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Sets a custom icon name. Returns the builder instance for chaining.

```APIDOC
## icon(string $icon)

### Description
Sets a custom icon name. If not set, `send()` computes the per-model default via `NotificationType::getDefaultIcon()`. Returns `$this` for chaining.

### Method
icon

### Signature
`public function icon(string $icon): self`

### Parameters
#### Parameters
- **$icon** (string) - Required - Emoji, or a Blade component name resolved via `x-dynamic-component`.

### Returns
- `self` - The builder instance for chaining.

### Example
```php
notify()
    ->success()
    ->title('Welcome back')
    ->icon('untitledui-user-check')
    ->send();
```
```

--------------------------------

### toArray() output shape

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Shows the exact output shape of toArray(). The method key is null for URL actions and defaults to 'POST' for execution actions. openUrlInNewTab is always a boolean.

```php
[
    'label' => ?string,
    'url' => ?string,
    'action' => ?string,
    'classes' => ?string,
    'method' => $this->action !== null ? ($this->method ?? 'POST') : null,
    'openUrlInNewTab' => bool,
]
```

--------------------------------

### send(): void

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Validates the assembled state, computes unresolved defaults, flashes the payload to the session under the notify key, and resets the builder for reuse. Throws InvalidNotificationException on validation failures.

```APIDOC
## send(): void

### Description
Validates the assembled state, computes unresolved defaults, flashes the payload to the session under the `notify` key, and resets the builder for reuse. Throws `InvalidNotificationException` on validation failures.

### Method
- (Fluent method on Notify builder)

### Parameters
#### Parameters
- None.

### Request Example
```php
public function destroy(User $user)
{
    $user->delete();

    notify()
        ->success()
        ->title('User deleted')
        ->message('The user has been moved to trash')
        ->actions([
            NotifyAction::make()
                ->label('Undo')
                ->action(route('users.restore', $user->id))
                ->method('POST'),
            NotifyAction::make()
                ->label('View Trash')
                ->url(route('users.trash'))
                ->openUrlInNewTab(),
        ])
        ->send();

    return redirect()->route('users.index');
}
```

### Response
#### Success Response
- Returns `void`.

#### Response Example
```php
// No direct response; flashes payload to session under 'notify' key.
```

### Error Handling
#### Error Conditions
- **InvalidNotificationException** - `NotificationModel::Drake` combined with a non-empty `title` ("The Drake notification cannot have a title. Remove ->title() call.")
- **InvalidNotificationException** - `NotificationModel::Drake` combined with a non-empty `message` ("The Drake notification cannot have a message. Remove ->message() call.")
- **InvalidNotificationException** - `NotificationModel::Drake` combined with a non-empty `actions` list ("The Drake notification cannot have actions. Remove ->actions() call.")
- **InvalidNotificationException** - Any attached action with an empty label ("All notification actions must have a label. Use ->label() method on NotifyAction.")

#### Error Example
```php
use Mckenziearts\Notify\Exceptions\InvalidNotificationException;

try {
    notify()
        ->model(NotificationModel::Drake)
        ->title('This is forbidden')
        ->send();
} catch (InvalidNotificationException $e) {
    // $e->getMessage() === 'The Drake notification cannot have a title...'
    report($e);
}
```

### Source
`src/Notify.php:116` (validation: `src/Notify.php:138`).
```

--------------------------------

### Getters

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Collection of getter methods to retrieve action properties such as label, URL, action, classes, method, and flags for new tab and existence checks.

```APIDOC
## Getters

### Description
Provides read access to the action's properties and state.

### Methods
- `getLabel(): ?string` - Label text, `null` if unset. Source: `src/Action/NotifyAction.php:96`.
- `getUrl(): ?string` - URL for navigation actions, `null` otherwise. Source: `src/Action/NotifyAction.php:101`.
- `getAction(): ?string` - Execution URL, `null` otherwise. Source: `src/Action/NotifyAction.php:106`.
- `getClasses(): ?string` - Custom CSS classes, `null` if unset. Source: `src/Action/NotifyAction.php:111`.
- `getMethod(): ?string` - Normalized (uppercased) method if `method()` was called, otherwise `null`. Note it does **not** default to `'POST'` — the `'POST'` default is applied only inside `toArray()` when `action` is set. Source: `src/Action/NotifyAction.php:116`.
- `shouldOpenUrlInNewTab(): bool` - `true` when `openUrlInNewTab()` was called with a truthy value (default `false`). Source: `src/Action/NotifyAction.php:121`.
- `hasUrl(): bool` - `true` if a URL is set (navigation kind). Source: `src/Action/NotifyAction.php:126`.
- `hasAction(): bool` - `true` if an action URL is set (execution kind). Source: `src/Action/NotifyAction.php:131`.

### Example
```php
$action = NotifyAction::make()
    ->label('View')
    ->url('https://example.com');

if ($action->hasUrl()) {
    // navigation action
    echo $action->getUrl();
}
```

### Source
`src/Action/NotifyAction.php:96-136`.
```

--------------------------------

### title() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Method signature for title(). Sets the headline text of the notification.

```php
public function title(string $title): self
```

--------------------------------

### notifyJs() function signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/helpers.md

The signature of the notifyJs() helper function, which returns a string.

```php
function notifyJs(): string
```

--------------------------------

### NotifyServiceProvider class definition

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-service-provider.md

The main service provider class that registers the package with Laravel. It extends ServiceProvider and declares boot(), register(), registerBladeDirective(), and bootPublishes() methods.

```php
<?php

declare(strict_types=1);

namespace Mckenziearts\Notify;

use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Facades\Blade;
use Illuminate\Support\ServiceProvider;

final class NotifyServiceProvider extends ServiceProvider
{
    public function boot(): void
    public function register(): void
    public function registerBladeDirective(): void
    public function bootPublishes(): void
}
```

--------------------------------

### warning() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Method signature for warning(). Sets the notification type to 'warning' and returns $this.

```php
public function warning(): self
```

--------------------------------

### Basic usage with NotifyAction

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Adds interactive actions to a success notification. Actions support navigation via url() or execution via action(). Requires the NotifyAction class and is supported only for Toast, Connect, Smiley, and Emotify models.

```php
use Mckenziearts\Notify\Action\NotifyAction;

notify()
    ->success()
    ->title('User deleted successfully')
    ->actions([
        NotifyAction::make()
            ->label('Undo')
            ->action(route('users.restore', $user->id)),
        NotifyAction::make()
            ->label('View All')
            ->url(route('users.index')),
    ])
    ->send();
```

--------------------------------

### success() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Method signature for success(). Sets the notification type to 'success' and returns $this for chaining.

```php
public function success(): self
```

--------------------------------

### classes()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Sets extra CSS classes applied to the rendered button or link. When unset, a default class is used.

```APIDOC
## classes()

### Description
Sets extra CSS classes applied to the rendered <a> or <button>. Tailwind utility strings, e.g. from the README custom styling example. When unset, the rendered element falls back to the component default (text-blue-600 hover:text-blue-500 dark:text-blue-400 dark:hover:text-blue-300).

### Method
classes

### Signature
`public function classes(string $classes): self`

### Parameters
- **$classes** (string) - Required - Space-separated CSS classes.

### Returns
- **self** - Returns the current NotifyAction instance for chaining.

### Example
```php
NotifyAction::make()
    ->label('Delete')
    ->action(route('users.delete', $user->id))
    ->method('DELETE')
    ->classes('text-red-600 hover:text-red-500 font-bold');
```
```

--------------------------------

### notifyJs() function implementation

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/helpers.md

The implementation of notifyJs() that returns an HTML script tag for the compiled JavaScript.

```php
function notifyJs(): string
{
    return '<script type="text/javascript" src="'.asset('vendor/mckenziearts/laravel-notify/dist/notify.js').'"></script>';
}
```

--------------------------------

### Preset notification usage

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Uses a preset notification defined in the config file. The preset name is passed to the preset() method.

```php
notify()->preset('common-notification')->send();
```

--------------------------------

### Configure Tailwind to scan package files

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Add the @source directive to your resources/css/app.css file to include the package's Blade files in Tailwind's content sources.

```css
@import "tailwindcss";

@source "../../vendor/mckenziearts/laravel-notify/resources/views/**/*.blade.php";
```

--------------------------------

### NotifyAction::action() method

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Makes this an execution action: the button sends an HTTP request to the given URL (POST by default, configurable with method()). Rendered as a <button> with an Alpine fetch() handler. Throws InvalidNotificationException if url() was already called.

```php
public function action(string $action): self
```

--------------------------------

### label()

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Sets the visible text for the action button. This method is required; omitting it will cause an exception when the notification is sent.

```APIDOC
## label()

### Description
Sets the button's visible text. This method is required; omitting it will cause an exception when the notification is sent.

### Method
label

### Signature
`public function label(string $label): self`

### Parameters
- **$label** (string) - Required - The visible button text.

### Returns
- **self** - Returns the current NotifyAction instance for chaining.

### Throws
- **InvalidNotificationException** - If the label is blank when the notification is sent.

### Example
```php
NotifyAction::make()
    ->label('Undo')
    ->action(route('users.restore', $user->id));
```
```

--------------------------------

### Default duration configuration

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Configures the default notification timeout in config/notify.php using the NOTIFY_TIMEOUT environment variable, defaulting to 5000 milliseconds.

```php
'timeout' => env('NOTIFY_TIMEOUT', 5000),
```

--------------------------------

### getMessage() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Declares the getMessage() method that reads the flashed message from the session.

```php
public function getMessage(): ?string
```

--------------------------------

### send() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Declares the send() method that validates and sends the notification, throwing InvalidNotificationException on failure.

```php
/**
 * Send the notification to the session
 *
 * @throws InvalidNotificationException
 */
public function send(): void
```

--------------------------------

### notifyCss() function implementation

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/helpers.md

The implementation of notifyCss() that returns an HTML link tag for the compiled CSS.

```php
function notifyCss(): string
{
    return '<link rel="stylesheet" type="text/css" href="'.asset('vendor/mckenziearts/laravel-notify/dist/notify.css').'"/>';
}
```

--------------------------------

### Layout with Laravel Notify directives

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/README.md

Adds the @notifyCss directive in the head, the <x-notify::notify /> component in the body, and the @notifyJs directive before closing body. Loads pre-compiled assets from public/vendor/mckenziearts/laravel-notify/dist/.

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Laravel Notify</title>

    <!-- Add Laravel Notify CSS -->
    @notifyCss
</head>
<body>

    <!-- Add notification component -->
    <x-notify::notify />

    <!-- Add Laravel Notify JavaScript -->
    @notifyJs
</body>
</html>
```

--------------------------------

### message() method signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify.md

Method signature for message(). Sets the message body text shown below the title.

```php
public function message(string $message): self
```

--------------------------------

### openUrlInNewTab() signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Declares the openUrlInNewTab() method that controls whether a URL action opens in a new tab. Defaults to true. Throws InvalidNotificationException if called on an action with an action() URL.

```php
public function openUrlInNewTab(bool $openInNewTab = true): self
```

--------------------------------

### notifyCss() function signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/helpers.md

The signature of the notifyCss() helper function, which returns a string.

```php
function notifyCss(): string
```

--------------------------------

### toArray() signature

Source: https://github.com/mckenziearts/laravel-notify/blob/3.x/_autodocs/api-reference/notify-action.md

Declares the toArray() method that serializes the action for session storage. Returns an array with string keys and mixed values.

```php
/**
 * @return array<string, mixed>
 */
public function toArray(): array
```
Tokens:
Raw