Livewire Toaster

https://github.com/masmerise/livewire-toaster
Admin
Livewire Toaster provides a seamless experience to display beautiful toast notifications in...
Tokens:40,682
Snippets:312
Trust Score:5.5
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install livewire-toaster via Composer

Source: https://github.com/masmerise/livewire-toaster/blob/master/README.md

Install the package via Composer.

```bash
composer require masmerise/livewire-toaster
```

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

### Usage example with Toaster::fake()

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/TestableCollector.md

Example test using Toaster::fake() to install the TestableCollector. It asserts nothing is dispatched initially, performs a POST request, then asserts a toast with the message 'Welcome!' was dispatched. Note: when translate is enabled, assert against translation keys, not human-readable translations.

```php
use Masmerise\Toaster\Toaster;

final class RegisterUserControllerTest extends TestCase
{
    public function users_can_register(): void
    {
        // Arrange
        Toaster::fake();
        Toaster::assertNothingDispatched();

        // Act
        $response = $this->post('users', [ ... ]);

        // Assert
        $response->assertRedirect('profile');
        Toaster::assertDispatched('Welcome!');
    }
}
```

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

### Usage Examples

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toaster.md

Examples of using the Toaster facade in Livewire components and controllers.

```APIDOC
## Example: Basic use in a Livewire component

```php
use Masmerise\Toaster\Toaster;

final class RegistrationForm extends Component
{
    public function submit(): void
    {
        $this->validate();

        // ...

        Toaster::success('User created!'); // auto-dispatches when the PendingToast is destroyed
    }
}
```
```

```APIDOC
## Example: With translation replacements and an error path

```php
use Masmerise\Toaster\Toaster;

public function invite(Request $request): RedirectResponse
{
    if ($request->missing('email')) {
        Toaster::error('validation.email.required', ['attribute' => 'e-mail address']);
        return back();
    }

    Mail::to($request->string('email'))->send(new Invitation());

    Toaster::info('user.invited', ['name' => $request->user()->name]);

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

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

### Import Toaster in app.js

Source: https://github.com/masmerise/livewire-toaster/blob/master/README.md

Import Toaster at the top of resources/js/app.js to start listening to incoming toasts.

```js
import './bootstrap';
import '../../vendor/masmerise/livewire-toaster/resources/js'; // 👈

// other app stuff...
```

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

### Adjust Toaster import in app.js for v2

Source: https://github.com/masmerise/livewire-toaster/blob/master/UPGRADING.md

Shows the required changes to app.js for v2: add the package's JS import and remove the manual Alpine setup (import, plugin, and start calls) since Livewire now registers Alpine automatically.

```diff
import './bootstrap';
+ import '../../vendor/masmerise/livewire-toaster/resources/js';

- import Alpine from 'alpinejs';
- import Toaster from '../../vendor/masmerise/livewire-toaster/resources/js';

- Alpine.plugin(Toaster);

- window.Alpine = Alpine;
- Alpine.start();
```

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

### PendingToast::create()

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/PendingToast.md

Creates a new PendingToast instance. Used in examples to start a toast builder chain.

```APIDOC
## PendingToast::create()

### Description
Creates a new PendingToast instance. Used in examples to start a toast builder chain.

### Method
create

### Signature
`public static function create(): PendingToast`

### Usage
```php
$toast = PendingToast::create();
```
```

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

### ToastBuilder::create(): ToastBuilder

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/ToastBuilder.md

Returns an empty builder. Duration, message, and type must all be set before get().

```APIDOC
## ToastBuilder::create(): ToastBuilder

### Description
Returns an empty builder. Duration, message, and type must all be set before `get()`.

### Method
`ToastBuilder::create()`

### Parameters
None.

### Returns
- **ToastBuilder** - A new empty builder instance.

### Source
`src/ToastBuilder.php:18`
```

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

### Publish toaster config: php artisan vendor:publish --tag=toaster-config

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/configuration.md

Use this command to publish the package's configuration file `config/toaster.php` to your application's `config/` directory. Run it after installing the package to customize options like `alignment`, `duration`, and `position`.

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

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

### Using redirect macros in a controller

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toastable.md

Example of using the redirect macros in a controller. The error and info methods are chained on RedirectResponse objects to dispatch toasts.

```php
final class CompanyController extends Controller
{
    public function store(Request $request): RedirectResponse
    {
        $validator = Validator::make($request->all(), [...]);

        if ($validator->fails()) {
            return Redirect::back()
                ->error('The form contains several errors'); // 👈 type `error`
        }

        Company::create($validator->validate());

        return Redirect::route('dashboard')
            ->info('Company created!'); // 👈 type `info`
    }
}
```

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

### PendingToast::message()

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/PendingToast.md

Sets the toast message. Used in examples to specify the text to display.

```APIDOC
## PendingToast::message()

### Description
Sets the toast message. Used in examples to specify the text to display.

### Method
message

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

### Usage
```php
$toast->message('User updated!');
```
```

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

### Explicit dispatch with duration and immediate dispatch

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/PendingToast.md

Explicit dispatch example. Calling `dispatch()` immediately sends the toast and prevents the destructor from re-dispatching, so any missing-builder error surfaces right away instead of at destruction.

```php
use Masmerise\Toaster\PendingToast;

$toast = PendingToast::create();

// 'User updated!' with a custom 5000 ms on-screen duration
$toast->message('User updated!')->duration(5000)->success();
$toast->dispatch(); // dispatches now; __destruct() will not re-dispatch
```

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

### Using Toastable trait in a Livewire component

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toastable.md

Example of using the Toastable trait in a Livewire component. The trait adds methods like $this->warning() to dispatch toasts.

```php
use Masmerise\Toaster\Toastable;

final class ProductListing extends Component
{
    use Toastable; // 👈 adds $this->success() etc.

    public function check(): void
    {
        $result = Product::query()->count();

        if ($result < 5) {
            $this->warning('The quantity on hand is critically low.'); // 👈
        }
    }
}
```

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

### PendingToast::success()

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/PendingToast.md

Sets the toast type to success. Used in examples to indicate a successful operation.

```APIDOC
## PendingToast::success()

### Description
Sets the toast type to success. Used in examples to indicate a successful operation.

### Method
success

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

### Usage
```php
$toast->success();
```
```

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

### ToastBuilder Methods

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/ToastBuilder.md

Code snippets for the ToastBuilder type mutators, type() method, and get() method.

```APIDOC
## `error()`

### Description
Returns a cloned builder with the `Error` toast type.

### Signature
`error(): ToastBuilder`

### Parameters
None.

### Returns
`ToastBuilder` - A cloned builder with the `Error` type set.

### Source
`src/ToastBuilder.php:38`
```

```APIDOC
## `info()`

### Description
Returns a cloned builder with the `Info` toast type.

### Signature
`info(): ToastBuilder`

### Parameters
None.

### Returns
`ToastBuilder` - A cloned builder with the `Info` type set.

### Source
`src/ToastBuilder.php:43`
```

```APIDOC
## `success()`

### Description
Returns a cloned builder with the `Success` toast type.

### Signature
`success(): ToastBuilder`

### Parameters
None.

### Returns
`ToastBuilder` - A cloned builder with the `Success` type set.

### Source
`src/ToastBuilder.php:53`
```

```APIDOC
## `warning()`

### Description
Returns a cloned builder with the `Warning` toast type.

### Signature
`warning(): ToastBuilder`

### Parameters
None.

### Returns
`ToastBuilder` - A cloned builder with the `Warning` type set.

### Source
`src/ToastBuilder.php:63`
```

```APIDOC
## `ToastBuilder::type(string $type): ToastBuilder`

### Description
Sets the toast type from a string. Maps the string through `ToastType::from()`. Throws `ValueError` for any other string (native PHP enum behavior).

### Signature
`ToastBuilder::type(string $type): ToastBuilder`

### Parameters
- **$type** (string) - Required - One of `'error'`, `'info'`, `'success'`, `'warning'`.

### Returns
`ToastBuilder` - The builder instance.

### Throws
- `ValueError` - If the string is not one of the valid types.

### Source
`src/ToastBuilder.php:58`
```

```APIDOC
## `ToastBuilder::get(): Toast`

### Description
Validates that duration, message, and type are all set, then returns the assembled `Toast`. Throws `UnexpectedValueException` (one of three distinct messages) if any is missing.

### Signature
`ToastBuilder::get(): Toast`

### Parameters
None.

### Returns
`Toast` - The assembled toast object.

### Throws
- `UnexpectedValueException` - If duration, message, or type is missing.

### Source
`src/ToastBuilder.php:68`
```

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

### ToastBuilder class implementation

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/ToastBuilder.md

Full implementation of the ToastBuilder class. Use it to fluently build Toast value objects. Each mutator clones the builder, so chaining never mutates earlier states, making proto() reuse safe. The get() method throws UnexpectedValueException if duration, message, or type is missing.

```php
<?php declare(strict_types=1);

namespace Masmerise\Toaster;

use Illuminate\Support\Traits\Conditionable;
use UnexpectedValueException;

final class ToastBuilder
{
    use Conditionable;

    private ?Duration $duration = null;

    private ?Message $message = null;

    private ?ToastType $type = null;

    public static function create(): self
    {
        return new self();
    }

    public static function proto(Toast $toast): self
    {
        $builder = self::create();
        $builder->duration = $toast->duration;
        $builder->message = $toast->message;
        $builder->type = $toast->type;

        return $builder;
    }

    public function duration(int $milliseconds): self
    {
        return $this->modify('duration', Duration::fromMillis($milliseconds));
    }

    public function error(): self
    {
        return $this->modify('type', ToastType::Error);
    }

    public function info(): self
    {
        return $this->modify('type', ToastType::Info);
    }

    public function message(string $message, array $replace = []): self
    {
        return $this->modify('message', Message::fromTranslatable($message, $replace));
    }

    public function success(): self
    {
        return $this->modify('type', ToastType::Success);
    }

    public function type(string $type): self
    {
        return $this->modify('type', ToastType::from($type));
    }

    public function warning(): self
    {
        return $this->modify('type', ToastType::Warning);
    }

    public function get(): Toast
    {
        if (! $this->duration instanceof Duration) {
            throw new UnexpectedValueException('You must provide a valid duration.');
        }

        if (! $this->message instanceof Message) {
            throw new UnexpectedValueException('You must provide a valid message.');
        }

        if (! $this->type instanceof ToastType) {
            throw new UnexpectedValueException('You must choose a valid type.');
        }

        return new Toast($this->message, $this->duration, $this->type);
    }

    private function modify(string $property, mixed $value): self
    {
        $that = clone $this;
        $that->{$property} = $value;

        return $that;
    }
}
```

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

### Handle validation failures when building a toast

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/ToastBuilder.md

Demonstrates catching InvalidArgumentException when duration is below the minimum (3000 ms), logging a warning, and falling back to a valid duration. Note that get() throws UnexpectedValueException if all three properties are not set.

```php
use Masmerise\Toaster\ToastBuilder;

try {
    $toast = ToastBuilder::create()
        ->duration(2500)          // throws InvalidArgumentException (min 3000)
        ->message('Still saved!')
        ->success()
        ->get();
} catch (InvalidArgumentException $e) {
    Log::warning('Toast duration rejected', ['error' => $e->getMessage()]);

    $toast = ToastBuilder::create()->duration(3000)->message('Saved!')->success()->get();
}

Toaster::collect($toast);
```

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

### Build and dispatch a toast via dependency injection

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/ToastBuilder.md

Shows how to create a toast using ToastBuilder, set duration, type, and message, then collect it via the Collector. Uses ToasterConfig for duration and handles a Verified event.

```php
use Masmerise\Toaster\Collector;
use Masmerise\Toaster\ToasterConfig;
use Masmerise\Toaster\ToastBuilder;

final readonly class SendEmailVerifiedNotification
{
    public function __construct(
        private ToasterConfig $config,
        private Collector $toasts,
    ) {}

    public function handle(Verified $event): void
    {
        $toast = ToastBuilder::create()
            ->duration($this->config->duration)
            ->success()
            ->message("Thank you, {$event->user->name}!")
            ->get();

        $this->toasts->collect($toast);
    }
}
```

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

### Constructing and collecting a toast

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toast.md

Shows how to build a Toast using ToastBuilder and collect it via the Collector. The toast is created with a duration of 3000ms, message 'Backup complete', and warning type.

```php
use Masmerise\Toaster\Collector;
use Masmerise\Toaster\Toast;
use Masmerise\Toaster\ToastBuilder;

$toast = ToastBuilder::create()
    ->duration(3000)
    ->message('Backup complete')
    ->warning()
    ->get(); // Toast

app(Collector::class)->collect($toast);
```

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

### Dispatching through injection with ToastBuilder

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Collector.md

Demonstrates dispatching a toast through constructor injection of the Collector, without using the facade. It builds a toast with ToastBuilder and collects it.

```php
use Masmerise\Toaster\Collector;
use Masmerise\Toaster\ToastBuilder;

final class NotificationJob
{
    public function __construct(private Collector $toasts) {}

    public function handle(User $user): void
    {
        $toast = ToastBuilder::create()
            ->duration(3000)
            ->info()
            ->message("Signed in as {$user->name}")
            ->get();

        $this->toasts->collect($toast);
    }
}

```

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

### Toast class

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/JavaScript.md

Documentation for the Toast class, including constructor, static factory, instance methods, and fields.

```APIDOC
## `Toast` class

### Description
Represents a single toast notification with lifecycle management (show, dispose, timeout) and equality comparison.

### Constructor
`constructor(duration: number, message: string, type: string)`

Initializes a new Toast instance with the given duration, message, and type. Sets `$el = null`, `id = uuid41()`, `isVisible = false`, `timeout = null`, `trashed = false`.

### Static Methods

#### `fromJson(data)`
- **Signature**: `static fromJson(data: { duration, message, type }): Toast`
- **Description**: Factory method used by the hub and session toasts to create a Toast instance from JSON data.

### Instance Methods

#### `dispose()`
- **Signature**: `dispose(): void`
- **Description**: Clears the timeout, sets `isVisible = false`, and marks `trashed` on transition end or cancel.

#### `equals(other)`
- **Signature**: `equals(other: Toast): boolean`
- **Description**: Compares `duration`, `message`, and `type` to determine if two toasts are similar/duplicate. Used as the predicate for `replace`/`suppress` operations.

#### `runAfterDuration(callback)`
- **Signature**: `runAfterDuration(callback: (toast: Toast) => void): void`
- **Description**: Schedules a callback to run after the toast's duration using `setTimeout`. Stores the timeout handle in `this.timeout`.

#### `select(config)`
- **Signature**: `select(config: Record<string, string>): string`
- **Description**: Returns `config[this.type]`, used by the hub view to apply per-type CSS classes.

#### `show($el)`
- **Signature**: `show($el: HTMLElement): void`
- **Description**: Binds the toast to a DOM element and sets `isVisible = true`.

### Fields
- `$el` (HTMLElement | null) - The bound DOM element.
- `id` (string) - Unique identifier generated by `uuid41()`.
- `isVisible` (boolean) - Whether the toast is currently visible.
- `duration` (number) - Display duration in milliseconds.
- `message` (string) - The toast message content.
- `timeout` (number | null) - Handle for the timeout set by `runAfterDuration`.
- `trashed` (boolean) - Whether the toast has been marked for removal.
- `type` (string) - The toast type (e.g., 'error', 'info', 'success', 'warning').
```

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

### ToastBuilder::create()

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/ToastBuilder.md

Static factory method that returns a new ToastBuilder instance.

```APIDOC
## ToastBuilder::create()

### Description
Creates a new ToastBuilder instance.

### Method
create

### Signature
public static function create(): self

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

```

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

### PendingToast::duration()

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/PendingToast.md

Sets the on-screen duration in milliseconds. Used in examples to customize how long the toast is displayed.

```APIDOC
## PendingToast::duration()

### Description
Sets the on-screen duration in milliseconds. Used in examples to customize how long the toast is displayed.

### Method
duration

### Signature
`public function duration(int $milliseconds): PendingToast`

### Usage
```php
$toast->duration(5000);
```
```

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

### Mixing ToastableMacros into Redirector and RedirectResponse

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toastable.md

The ToasterServiceProvider boot method mixes the ToastableMacros instance into both Redirector and RedirectResponse classes.

```php
Redirector::mixin($macros = new ToastableMacros());
RedirectResponse::mixin($macros);
```

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

### Inject ToasterConfig into a service

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/ToasterConfig.md

Demonstrates constructor injection of ToasterConfig and Collector into a service, using the config's duration to build a toast and collect it.

```php
use Masmerise\Toaster\Collector;
use Masmerise\Toaster\ToasterConfig;
use Masmerise\Toaster\ToastBuilder;

final readonly class SomeHandler
{
    public function __construct(
        private ToasterConfig $config,
        private Collector $toasts,
    ) {}

    public function handle(): void
    {
        $toast = ToastBuilder::create()
            ->duration($this->config->duration)
            ->success()
            ->message('Done')
            ->get();

        $this->toasts->collect($toast);
    }
}
```

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

### index.js - Set window.Toaster and register Alpine plugin

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/JavaScript.md

This is the full content of resources/js/index.js. It sets window.Toaster and registers the Alpine plugin when the 'alpine:init' event fires.

```javascript
import { Hub } from './hub';
import * as Toaster from './toaster';

window.Toaster = Toaster;

document.addEventListener('alpine:init', () => {
    window.Alpine.plugin(Hub);
});
```

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

### Run tests with composer test

Source: https://github.com/masmerise/livewire-toaster/blob/master/README.md

Runs the test suite for the project using Composer.

```bash
composer test
```

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

### Import livewire-toaster in app entry bundle

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/JavaScript.md

Add these imports to your app's entry bundle (e.g., resources/js/app.js) to load the package. The second import is the package's index.js, which has side effects only.

```javascript
import './bootstrap';
import '../../vendor/masmerise/livewire-toaster/resources/js'; // 👈 (index.js)
```

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

### ToasterConfig::fromArray

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/ToasterConfig.md

Documentation for the ToasterConfig::fromArray static method, which creates a ToasterConfig instance from an array of configuration options.

```APIDOC
## ToasterConfig::fromArray(array $config): ToasterConfig

### Description
Creates a ToasterConfig instance from an array of configuration options. All keys are optional and unknown keys are ignored. The array is merged over hard-coded defaults.

### Method
fromArray

### Endpoint
ToasterConfig::fromArray

### Parameters
#### Request Body
- **$config** (array) - Required - Config subset; all keys optional; unknown keys ignored. Shape documented in PHPDoc.

### Request Example
```php
$config = ToasterConfig::fromArray([
    'alignment' => 'top',
    'duration' => 5000,
    'position' => 'center',
    'accessibility' => false,
    'closeable' => false,
    'replace' => true,
    'suppress' => true,
    'translate' => false,
]);
```

### Response
#### Success Response
- **ToasterConfig** (ToasterConfig) - The created configuration instance.

#### Response Example
```php
// Returns a ToasterConfig instance with merged defaults.
```

### Notes
- Values are not validated here; an invalid alignment/position string only fails (with ValueError) when alignment()/position() are called.
- Defaults: alignment 'bottom', duration 3000, position 'right', accessibility true, closeable true, replace false, suppress false, translate true.
```

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

### Basic usage in Livewire component

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toaster.md

Use Toaster::success() to show a success toast. The toast is auto-dispatched when the PendingToast is destroyed.

```php
use Masmerise\Toaster\Toaster;

final class RegistrationForm extends Component
{
    public function submit(): void
    {
        $this->validate();

        // ...

        Toaster::success('User created!'); // auto-dispatches when the PendingToast is destroyed
    }
}
```

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

### PendingToast::create()

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/PendingToast.md

Creates a pending toast pre-loaded with the configured default duration.

```APIDOC
## PendingToast::create(): PendingToast

### Description
Creates a pending toast pre-loaded with the configured default duration (`Toaster::config()->duration`).

### Method
create

### Signature
`PendingToast::create(): PendingToast`

### Parameters
None

### Returns
- **PendingToast** - A new pending toast instance.

### Source
`src/PendingToast.php:31`
```

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

### Config class with Alignment and fromJson (resources/js/config.js)

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/JavaScript.md

Defines the Config class that wraps alignment in a non-exported Alignment helper. fromJson mirrors ToasterConfig::toJavaScript() (src/ToasterConfig.php:57). isTop() drives unshift vs push ordering in hub.js.

```javascript
class Alignment {
    static Top = 'top';

    constructor(value) {
        this.value = value;
    }

    isTop() {
        return this.value === Alignment.Top;
    }
}

export class Config {
    constructor(alignment, duration, replace, suppress) {
        this.alignment = new Alignment(alignment);
        this.duration = duration;
        this.replace = replace;
        this.suppress = suppress;
    }

    static fromJson(data) {
        return new Config(data.alignment, data.duration, data.replace, data.suppress);
    }
}
```

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

### Manual translation with Lang::get

Source: https://github.com/masmerise/livewire-toaster/blob/master/README.md

Manual translation approach before using automatic translation. Requires the translate configuration value to be true for the automatic alternative.

```php
Toaster::success(
    Lang::get('path.to.translation', ['replacement' => 'value'])
);

```

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

### Toaster Facade Methods

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toaster.md

Static methods available on the Toaster facade for creating and managing toasts.

```APIDOC
## Toaster::config()

### Description
Returns the Toaster configuration instance.

### Method
config()

### Return Value
- **ToasterConfig** - The configuration instance.

### Example
```php
$config = Toaster::config();
```
```

```APIDOC
## Toaster::error(string $message, array $replace = []): PendingToast

### Description
Creates a new toast with an error type and the given message.

### Parameters
- **$message** (string) - Required - The message to display.
- **$replace** (array) - Optional - Replacement pairs for placeholders in the message.

### Return Value
- **PendingToast** - A pending toast instance configured with the error type.

### Example
```php
Toaster::error('Something went wrong.');
```
```

```APIDOC
## Toaster::fake(): TestableCollector

### Description
Swaps the underlying collector with a testable fake and returns it.

### Return Value
- **TestableCollector** - The fake collector instance for testing.

### Example
```php
Toaster::fake();
```
```

```APIDOC
## Toaster::info(string $message, array $replace = []): PendingToast

### Description
Creates a new toast with an info type and the given message.

### Parameters
- **$message** (string) - Required - The message to display.
- **$replace** (array) - Optional - Replacement pairs for placeholders in the message.

### Return Value
- **PendingToast** - A pending toast instance configured with the info type.

### Example
```php
Toaster::info('New update available.');
```
```

```APIDOC
## Toaster::success(string $message, array $replace = []): PendingToast

### Description
Creates a new toast with a success type and the given message.

### Parameters
- **$message** (string) - Required - The message to display.
- **$replace** (array) - Optional - Replacement pairs for placeholders in the message.

### Return Value
- **PendingToast** - A pending toast instance configured with the success type.

### Example
```php
Toaster::success('Operation completed.');
```
```

```APIDOC
## Toaster::toast(): PendingToast

### Description
Creates a new pending toast instance.

### Return Value
- **PendingToast** - A new pending toast instance.

### Example
```php
$toast = Toaster::toast();
```
```

```APIDOC
## Toaster::warning(string $message, array $replace = []): PendingToast

### Description
Creates a new toast with a warning type and the given message.

### Parameters
- **$message** (string) - Required - The message to display.
- **$replace** (array) - Optional - Replacement pairs for placeholders in the message.

### Return Value
- **PendingToast** - A pending toast instance configured with the warning type.

### Example
```php
Toaster::warning('Please review your input.');
```
```

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

### PendingToast::dispatch()

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/PendingToast.md

Builds the Toast and sends it to the Collector service, then marks the instance as dispatched.

```APIDOC
## PendingToast::dispatch(): void

### Description
Builds the `Toast` via `ToastBuilder::get()` and sends it to `Toaster::collect($toast)` (i.e., the `Collector` service), then marks the instance as dispatched so the destructor does not fire a second toast.

### Method
dispatch

### Signature
`PendingToast::dispatch(): void`

### Parameters
None

### Throws
- **UnexpectedValueException** - if the underlying `ToastBuilder` lacks a duration, message, or type at `get()` time.

### Source
`src/PendingToast.php:36`
```

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

### Toaster::config()

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toaster.md

Returns the container-bound ToasterConfig instance.

```APIDOC
## Toaster::config(): ToasterConfig

### Description
Returns the container-bound `ToasterConfig` instance (alias `toaster.config`, `ToasterServiceProvider::CONFIG`).

### Method
N/A (static method)

### Endpoint
N/A

### Parameters
No parameters.

### Return
`ToasterConfig`

### Source
`src/Toaster.php:15`
```

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

### RTL support with dir="rtl"

Source: https://github.com/masmerise/livewire-toaster/blob/master/README.md

Add the rtl attribute to the document root for RTL languages to flip UI elements and align text properly.

```html
<!DOCTYPE html>
<html dir="rtl"> <!-- 👈 -->
    ...
</html>
```

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

### With translation replacements and error path

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toaster.md

Use Toaster::error() and Toaster::info() with translation keys and replacements. The error path returns back() on missing email, otherwise sends an invitation and redirects to dashboard.

```php
use Masmerise\Toaster\Toaster;

public function invite(Request $request): RedirectResponse
{
    if ($request->missing('email')) {
        Toaster::error('validation.email.required', ['attribute' => 'e-mail address']);
        return back();
    }

    Mail::to($request->string('email'))->send(new Invitation());

    Toaster::info('user.invited', ['name' => $request->user()->name]);

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

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

### Dispatch toast with Toaster facade

Source: https://github.com/masmerise/livewire-toaster/blob/master/README.md

Use the Toaster facade to dispatch a success toast from a Livewire component after validation and user creation. This is the standard recommended way for dispatching toast messages from the back-end.

```php
use Masmerise\Toaster\Toaster;

final class RegistrationForm extends Component
{
    public function submit(): void
    {
        $this->validate();

        User::create($this->form);

        Toaster::success('User created!'); // 👈
    }
}

```

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

### Dispatch toast from front-end with Toaster

Source: https://github.com/masmerise/livewire-toaster/blob/master/README.md

Invoke the globally available Toaster instance from front-end JavaScript (e.g., Alpine.js) to dispatch a toast. Available methods: error, info, warning, success.

```html
<button @click="Toaster.success('Form submitted!')">
    Submit
</button>

```

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

### ToastBuilder::info()

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/ToastBuilder.md

Sets the toast type to Info. Returns a new builder instance with the updated type.

```APIDOC
## ToastBuilder::info()

### Description
Sets the toast type to Info. Returns a new builder instance with the updated type.

### Method
info

### Signature
public function info(): self

### Returns
- **self** - A new ToastBuilder instance with the type set to Info.

```

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

### Toast::__construct(Message $message, Duration $duration, ToastType $type)

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toast.md

Creates a new Toast instance with a message, duration, and type. In practice, Toast instances are constructed by ToastBuilder::get() rather than directly.

```APIDOC
## Toast::__construct(Message $message, Duration $duration, ToastType $type)

### Description
Creates a new Toast instance with a message, duration, and type. In practice, Toast instances are constructed by ToastBuilder::get() rather than directly.

### Method
Constructor

### Parameters
- `$message` (Message) - Required - Message value object; `->value` is the text, `->replace` the translator replacements
- `$duration` (Duration) - Required - Duration value object; `->value` is milliseconds (≥ 3000)
- `$type` (ToastType) - Required - String-backed enum: `'error'`, `'info'`, `'success'`, `'warning'`

### Source
`src/Toast.php:9-13`
```

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

### ToastBuilder::proto(Toast $toast)

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/ToastBuilder.md

Static factory method that creates a ToastBuilder from an existing Toast, copying its duration, message, and type.

```APIDOC
## ToastBuilder::proto(Toast $toast)

### Description
Creates a new ToastBuilder initialized with the properties of the given Toast.

### Method
proto

### Signature
public static function proto(Toast $toast): self

### Parameters
- **$toast** (Toast) - Required - The Toast to copy properties from.

### Returns
- **self** - A new ToastBuilder instance with the copied properties.

```

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

### Read ToasterConfig values via facade

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/ToasterConfig.md

Shows how to access the ToasterConfig through the Toaster facade, retrieving the duration as an integer, and the alignment and position as enums.

```php
use Masmerise\Toaster\Toaster;

$duration = Toaster::config()->duration;   // int, e.g. 3000
$align = Toaster::config()->alignment();   // Alignment enum
$position = Toaster::config()->position(); // Position enum
```

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

### Add <x-toaster-hub /> to master template

Source: https://github.com/masmerise/livewire-toaster/blob/master/README.md

Place the <x-toaster-hub /> component in your master template to render the toast container.

```html
<!DOCTYPE html>
<html>
<head>
    <!-- ... -->
</head>

<body>
    <!-- Application content -->

    <x-toaster-hub /> <!-- 👈 -->
</body>
</html>
```

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

### Redirector::info(string $message, array $replace = []): $this

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toastable.md

Dispatches an info toast and returns the same object for further chaining. Available on Redirector and RedirectResponse via mixin.

```APIDOC
## Redirector::info(string $message, array $replace = []): $this

### Description
Dispatches an info toast through the Collector and returns the same object for further chaining. Available on both Redirector and RedirectResponse via mixin.

### Method
info

### Parameters
- **$message** (string) - Required - Message text or translation key
- **$replace** (array) - Optional - Translator replacement values

### Return Type
$this (Redirector or RedirectResponse)
```

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

### Toastable::info(string $message, array $replace = []): PendingToast

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toastable.md

Dispatches an info toast. Delegates to Toaster::info().

```APIDOC
## Toastable::info(string $message, array $replace = []): PendingToast

### Description
Dispatches an info toast. Delegates to Toaster::info().

### Method
info

### Parameters
- **$message** (string) - Required - Message text or translation key
- **$replace** (array) - Optional - Translator replacement values

### Return Type
PendingToast
```

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

### PendingToast::__call()

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/PendingToast.md

Forwards method calls to the internal ToastBuilder, supporting immutable chaining.

```APIDOC
## PendingToast::__call(string $name, array $arguments): mixed

### Description
Forwards to `ToastBuilder`. Returns `$this` (the `PendingToast`) whenever the builder returns a new `ToastBuilder` (immutable chain), otherwise the raw result.

### Method
__call

### Signature
`PendingToast::__call(string $name, array $arguments): mixed`

### Parameters
- **$name** (string) - Required - Method name to forward to the internal `ToastBuilder`.
- **$arguments** (array) - Required - Arguments for the forwarded method.

### Forwarded Methods
- `duration`
- `error`
- `info`
- `message`
- `success`
- `type`
- `warning`
- Laravel's `Conditionable` (`when` / `unless`) is also forwarded through the same mechanism.

### Returns
- **mixed** - Returns `$this` when the builder returns a new `ToastBuilder`, otherwise the raw result.

### Source
`src/PendingToast.php:45`
```

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

### Dispatch toast via Collector and ToastBuilder

Source: https://github.com/masmerise/livewire-toaster/blob/master/README.md

Inject the Collector contract and use ToastBuilder to dispatch toasts in a pure, dependency-injected manner. Build a toast with duration, type, and message, then collect it.

```php
use Masmerise\Toaster\Collector;
use Masmerise\Toaster\ToasterConfig;
use Masmerise\Toaster\ToastBuilder;

final readonly class SendEmailVerifiedNotification
{
    public function __construct(
        private ToasterConfig $config,
        private Collector $toasts,
    ) {}

    public function handle(Verified $event): void
    {
        $toast = ToastBuilder::create()
            ->duration($this->config->duration)
            ->success()
            ->message("Thank you, {$event->user->name}!")
            ->get();

        $this->toasts->collect($toast);
    }
}

```

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

### Toastable::toast(): PendingToast

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toastable.md

Returns a bare pending toast. Delegates to Toaster::toast().

```APIDOC
## Toastable::toast(): PendingToast

### Description
Returns a bare pending toast. Delegates to Toaster::toast().

### Method
toast

### Parameters
None

### Return Type
PendingToast
```

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

### Create a custom Collector decorator for counting toasts

Source: https://github.com/masmerise/livewire-toaster/blob/master/README.md

Create a custom Collector decorator to track dispatched toasts. It wraps the next collector and delegates collect() and release() calls. Use this to add side effects like counting daily toasts.

```php
final readonly class DailyCountingCollector implements Collector
{
    public function __construct(private Collector $next) {}

    public function collect(Toast $toast): void
    {
        // increment the counter on durable storage

        $this->next->collect($toast);
    }

    public function release(): array
    {
        return $this->next->release();
    }
}
```

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

### ToastBuilder::warning()

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/ToastBuilder.md

Sets the toast type to Warning. Returns a new builder instance with the updated type.

```APIDOC
## ToastBuilder::warning()

### Description
Sets the toast type to Warning. Returns a new builder instance with the updated type.

### Method
warning

### Signature
public function warning(): self

### Returns
- **self** - A new ToastBuilder instance with the type set to Warning.

```

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

### Chain toast on RedirectResponse

Source: https://github.com/masmerise/livewire-toaster/blob/master/README.md

Chain Toaster methods (error, info) on RedirectResponse returned from controllers or Livewire components. Works with Redirect::back() and Redirect::route().

```php
final class CompanyController extends Controller
{
    /** @throws ValidationException */
    public function store(Request $request): RedirectResponse
    {
        $validator = Validator::make($request->all(), [...]);

        if ($validator->fails()) {
            return Redirect::back()
                ->error('The form contains several errors'); // 👈
        }

        Company::create($validator->validate());

        return Redirect::route('dashboard')
            ->info('Company created!'); // 👈
    }
}

```

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

### toaster.js - Dispatch functions (error, info, success, warning)

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/JavaScript.md

This is the full content of resources/js/toaster.js. It defines the event dispatch helper and the named exports for each toast type.

```javascript
const event = (message, type) => {
    document.dispatchEvent(new CustomEvent('toaster:received', { detail: { message, type }}));
};

const error = message => event(message, 'error');
const info = message => event(message, 'info');
const success = message => event(message, 'success');
const warning = message => event(message, 'warning');

export { error, info, success, warning }
```

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

### Config class constructor and fromJson

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/types.md

Defines the Config class used to hold toaster configuration. The constructor wraps the alignment value in an Alignment instance and stores duration, replace, and suppress flags. The static fromJson method creates a Config from a plain object. This class is accepted by the Hub(Alpine) toasterHub component, which receives the output of ToasterConfig::toJavaScript().

```javascript
export class Config {
    constructor(alignment, duration, replace, suppress) {
        this.alignment = new Alignment(alignment);
        this.duration = duration;
        this.replace = replace;
        this.suppress = suppress;
    }

    static fromJson(data) {
        return new Config(data.alignment, data.duration, data.replace, data.suppress);
    }
}
```

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

### Serializing a toast for a custom relay

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toast.md

Shows how to serialize a Toast to an array for a custom relay (e.g., queue or websocket). The resulting payload matches the expected wire format and is dispatched as a ToastDispatched event.

```php
use Masmerise\Toaster\Toast;

/** @param Toast $toast */
$payload = $toast->toArray();

// $payload === ['duration' => 3000, 'message' => 'Backup complete', 'type' => 'warning']

dispatch(new ToastDispatched($payload));
```

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

### Read effective toaster configuration with Toaster::config()

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/configuration.md

Read the effective configuration in application code using the Toaster facade. Access boolean, enum, and integer values as shown.

```php
use Masmerise\Toaster\Toaster;

$dismissable = Toaster::config()->wantsCloseableToasts; // bool
$alignment = Toaster::config()->alignment();             // Alignment enum
$position  = Toaster::config()->position();              // Position enum
$defaultDuration = Toaster::config()->duration;          // int
```

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

### ToastBuilder::success()

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/ToastBuilder.md

Sets the toast type to Success. Returns a new builder instance with the updated type.

```APIDOC
## ToastBuilder::success()

### Description
Sets the toast type to Success. Returns a new builder instance with the updated type.

### Method
success

### Signature
public function success(): self

### Returns
- **self** - A new ToastBuilder instance with the type set to Success.

```

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

### Toast class constructor with properties

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/types.md

Defines the Toast class representing a single toast notification. The constructor initializes properties such as $el, id (generated via uuid41), isVisible, duration, message, timeout, trashed, and type. The comment lists additional methods (fromJson, dispose, equals, runAfterDuration, select, show) whose full signatures are documented in the JavaScript API reference.

```javascript
export class Toast {
    constructor(duration, message, type) {
        this.$el = null;
        this.id = uuid41();
        this.isVisible = false;
        this.duration = duration;
        this.message = message;
        this.timeout = null;
        this.trashed = false;
        this.type = type;
    }
    // static fromJson(data), dispose(), equals(other), runAfterDuration(callback), select(config), show($el)
}
```

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

### Extending the chain with DailyCountingCollector

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Collector.md

Shows how to extend the collector chain with a counting decorator. The first block defines the DailyCountingCollector that wraps the next collector, and the second registers it in AppServiceProvider::register() using the extend method.

```php
use Masmerise\Toaster\Collector;

final readonly class DailyCountingCollector implements Collector
{
    public function __construct(private Collector $next) {}

    public function collect(Toast $toast): void
    {
        // increment the counter on durable storage

        $this->next->collect($toast);
    }

    public function release(): array
    {
        return $this->next->release();
    }
}

```

```php
// AppServiceProvider::register()
public function register(): void
{
    $this->app->extend(Collector::class,
        static fn (Collector $next) => new DailyCountingCollector($next)
    );
}

```

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

### Toaster::info

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toaster.md

Creates an info toast with the given message. Same signature and behavior as success(), but the toast type is info (ToastType::Info).

```APIDOC
## Toaster::info(string $message, array $replace = []): PendingToast

### Description
Creates an info toast with the given message. Same signature and behavior as success(), but the toast type is info (ToastType::Info).

### Method
info

### Signature
Toaster::info(string $message, array $replace = []): PendingToast

### Parameters
- **$message** (string) - Required - Toast text, or a translation key when translate is enabled.
- **$replace** (array) - Optional - Default: [] - Replacement values passed to the translator for translation keys.

### Return
PendingToast typed as info.
```

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

### Dispatch toast with Toastable trait

Source: https://github.com/masmerise/livewire-toaster/blob/master/README.md

Make any class Toastable to dispatch toasts from it. The trait provides methods like warning() directly on the component.

```php
use Masmerise\Toaster\Toastable;

final class ProductListing extends Component
{
    use Toastable; // 👈

    public function check(): void
    {
        $result = Product::query()
            ->tap(new Available())
            ->count();

        if ($result < 5) {
            $this->warning('The quantity on hand is critically low.'); // 👈
        }
    }
}

```

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

### Redirector::success(string $message, array $replace = []): $this

Source: https://github.com/masmerise/livewire-toaster/blob/master/_autodocs/api-reference/Toastable.md

Dispatches a success toast and returns the same object for further chaining. Available on Redirector and RedirectResponse via mixin.

```APIDOC
## Redirector::success(string $message, array $replace = []): $this

### Description
Dispatches a success toast through the Collector and returns the same object for further chaining. Available on both Redirector and RedirectResponse via mixin.

### Method
success

### Parameters
- **$message** (string) - Required - Message text or translation key
- **$replace** (array) - Optional - Translator replacement values

### Return Type
$this (Redirector or RedirectResponse)
```
Tokens:
Raw