Livewire Alert

https://github.com/jantinnerezo/livewire-alert
Admin
Livewire Alert is a Laravel Livewire package that brings SweetAlert2 notifications to your Livewire...
Tokens:61,980
Snippets:402
Trust Score:9.3
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install v3 of livewire-alert

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/README.md

Installs the last v3 release (v3.0.3) using Composer. v4 is recommended for new projects.

```bash
composer require jantinnerezo/livewire-alert:^3.0
```

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

### Install livewire-alert and SweetAlert2

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/index.md

Install the package via Composer, optionally publish its configuration file, and install the SweetAlert2 JavaScript library. The comment notes that after installing sweetalert2, you must set window.Swal = Swal in resources/js/app.js.

```bash
composer require jantinnerezo/livewire-alert
```

```bash
php artisan vendor:publish --tag=livewire-alert:config   # optional
```

```bash
npm install sweetalert2   # then: window.Swal = Swal in resources/js/app.js
```

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

### Install SweetAlert2 via yarn

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/README.md

Installs the SweetAlert2 JavaScript library using yarn.

```bash
yarn add sweetalert2
```

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

### Chained button configuration example

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-buttons.md

Full usage example chaining button configuration methods to display a confirmation dialog with custom button colors. Demonstrates enabling the confirm and deny buttons and setting their colors.

```php
LivewireAlert::title('Delete account?')
    ->question()
    ->withConfirmButton('Delete')
    ->withDenyButton('Keep it')
    ->confirmButtonColor('#d33')
    ->denyButtonColor('#3085d6')
    ->show();
```

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

### html method usage examples

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert.md

Shows two usage examples for the html method: one with a raw HTML string and one with a closure that returns a string. Both chain with title and show.

```php
LivewireAlert::title('Heads up')
    ->html('<em>Inline <strong>HTML</strong> body</em>')
    ->show();

LivewireAlert::title('Greeting')
    ->html(fn () => '<b>' . auth()->user()->name . '</b>') // closure form
    ->show();
```

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

### Install SweetAlert2 via npm

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/README.md

Installs the SweetAlert2 JavaScript library using npm.

```bash
npm install sweetalert2
```

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

### show(), close(), and update() method signatures and usage

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-presets.md

Code examples for the show, close, and update methods of the LivewireAlert component. The show method snapshot-renders the alert, close dismisses it, and update mutates it in place. The usage example shows how to use these methods in sequence, with the option to update all or a single option.

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

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

```php
/**
 * @param array<string, mixed>|null $options
 */
public function update(?array $options = null): void
```

```php
LivewireAlert::asLoading('Saving…')->show();

// ...after work — mutate the open alert in place (no new alert):
LivewireAlert::title('Saved!')
    ->success()
    ->timer(1500)
    ->update();

// or target a single option:
LivewireAlert::update(['html' => '<b>Almost done…</b>']);
```

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

### withOptions usage example

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-images.md

Example usage of withOptions to pass raw SweetAlert2 options like showCloseButton, background, and width.

```php
LivewireAlert::title('Privacy')
    ->withOptions([
        'showCloseButton' => true,
        'background' => '#1f2937',
        'width' => 600,
    ])
    ->show();
```

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

### Usage example with LivewireAlert facade

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert.md

Shows how to use the facade to display a success alert with a title. The comment notes that error, warning, info, or question can be used instead.

```php
use Jantinnerezo\LivewireAlert\Facades\LivewireAlert;

public function delete(): void
{
    LivewireAlert::title('Changes saved!')
        ->success()   // or ->error() / ->warning() / ->info() / ->question()
        ->show();
}
```

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

### Install livewire-alert via Composer

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/README.md

Requires the package with Composer. Run in your Laravel project root.

```bash
composer require jantinnerezo/livewire-alert
```

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

### LivewireAlert asLoading usage example

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-presets.md

Example of using asLoading to show a loading alert during long-running work. After the work, show a success alert or call close() to dismiss the loading alert.

```php
public function export(): void
{
    LivewireAlert::asLoading('Exporting…')->show();

    // ...long-running work, then close the alert:
    LivewireAlert::title('Done')->success()->show();   // or LivewireAlert::close()
}

```

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

### imageAlt usage example

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-images.md

Example usage of the imageAlt method in a LivewireAlert chain, setting the image URL, dimensions, and alt text before showing the alert.

```php
LivewireAlert::title('Team photo')
    ->imageUrl('/storage/team.png')
    ->imageWidth(400)
    ->imageHeight(200)
    ->imageAlt('The 2025 team')
    ->show();
```

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

### LivewireAlert asToast usage example

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-presets.md

Example of using asToast in a chain to display a success toast alert. The asToast method configures the alert as a toast, and show() renders it.

```php
LivewireAlert::title('Saved!')
    ->success()
    ->asToast()
    ->show();

```

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

### asConfirm(): Compose confirmation dialog with usage example

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-buttons.md

The asConfirm() method signature composes a confirmation dialog: applies the question() icon, enables confirm and deny buttons with configurable texts, and disables the auto-close timer. The example usage chains asConfirm() with onConfirm() and onDeny() to handle user responses.

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

```php
LivewireAlert::title('Are you sure?')
    ->text('This cannot be undone.')
    ->asConfirm()
    ->onConfirm('destroy')        // see livewire-alert-presets.md
    ->onDeny('keep')
    ->show();
```

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

### customClass usage example

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-images.md

Example usage of customClass to apply CSS classes to the popup and confirm button elements of a success alert.

```php
LivewireAlert::title('Styled')
    ->success()
    ->customClass([
        'popup' => 'my-popup',
        'confirmButton' => 'btn btn-green',
    ])
    ->show();
```

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

### Usage with withEmailInput and withSelectInput

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-inputs.md

Example usage of withEmailInput and withSelectInput. The submitted value arrives as the 'value' key of the argument object to the onConfirm handler. Use these to gather email or role selections with a confirm button.

```php
use Jantinnerezo\LivewireAlert\Facades\LivewireAlert;

public function askEmail(): void
{
    LivewireAlert::title('Subscribe')
        ->html('Enter your email to get updates.')
        ->withEmailInput('Email address', 'you@example.com')
        ->withConfirmButton('Subscribe')
        ->onConfirm('subscribe')          // receives ['value' => '<submitted email>']
        ->show();
}

public function chooseRole(): void
{
    LivewireAlert::title('Select role')
        ->withSelectInput([
            'admin' => 'Administrator',
            'writer' => 'Writer',
        ], 'Role', 'writer')
        ->withConfirmButton('OK')
        ->onConfirm('applyRole')
        ->show();
}
```

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

### Set confirm, deny, and dismiss handlers on a LivewireAlert

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-presets.md

Example alert configuration with confirm, deny, and dismiss callbacks. The onConfirm callback method receives an array that merges the provided data with the alert's value (the SweetAlert2 input value, or undefined if no input). The other callbacks receive the same payload structure but without the value key.

```php
public function confirmDelete(): void
{
    LivewireAlert::title('Delete post?')
        ->text('This is permanent.')
        ->asConfirm()
        ->onConfirm('destroyPost', ['id' => $this->postId])
        ->onDeny('keepPost')
        ->onDismiss('logDismiss')
        ->show();
}

// called by onConfirm — receives ['id' => ..., 'value' => ...] (null input → value)
public function destroyPost(array $payload): void
{
    // $payload['id'], $payload['value']
}
```

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

### Usage example: lock modal with allowOutsideClick and allowEscapeKey

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert.md

Shows how to lock the modal by passing false to allowOutsideClick and a closure returning false to allowEscapeKey. The closure form is evaluated client-side.

```php
LivewireAlert::title('Busy')
    ->html('Please wait…')
    ->allowOutsideClick(false)          // lock the modal
    ->allowEscapeKey(fn () => false)    // closure form
    ->show();
```

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

### LivewireAlertServiceProvider boot() method

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/service-provider.md

Boot method signature, returns void, delegates to registerPublishables().

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

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

### Instantiate LivewireAlert from container or manually

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert.md

Shows three ways to obtain a LivewireAlert instance: from the container with the class name, via the 'livewire-alert' binding alias, or by manual construction with the current Livewire component. Manual construction requires passing the current Livewire\Component instance.

```php
use Jantinnerezo\LivewireAlert\LivewireAlert;

// from the container (uses the "current" Livewire component)
$alert = app(LivewireAlert::class);

// binding alias
$alert = app('livewire-alert');

// manual construction
$alert = new LivewireAlert($this); // $this = current Livewire\Component
```

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

### Publish livewire-alert config

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/README.md

Optionally publishes the package configuration file using the tag livewire-alert:config.

```bash
php artisan vendor:publish --tag=livewire-alert:config
```

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

### LivewireAlert facade basic usage

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/facade.md

Shows basic usage of the facade inside a Livewire action. The static call chain is forwarded to the current Livewire component instance, so show() executes on that component.

```php
use Jantinnerezo\LivewireAlert\Facades\LivewireAlert;

public function save(): void
{
    LivewireAlert::title('Changes saved!')
        ->success()
        ->show();   // LivewireAlert::show() runs on the current component
}
```

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

### Catching InvalidPositionException

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/errors.md

Example of catching InvalidPositionException when an invalid position string is passed, falling back to the enum form.

```php
use Jantinnerezo\LivewireAlert\Exceptions\InvalidPositionException;

public function notify(): void
{
    try {
        app(LivewireAlert::class)->title('Hi')->position('top-right')->show();
    } catch (InvalidPositionException $e) {
        // fall back to the enum form
        app(LivewireAlert::class)
            ->title('Hi')
            ->position(\Jantinnerezo\LivewireAlert\Enums\Position::Center)
            ->show();
    }
}
```

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

### config/livewire-alert.php defaults

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/configuration.md

Full contents of config/livewire-alert.php. All ten keys are valid Enums\Option backing values and are always forwarded to SweetAlert2. Defaults: position center, timer 3000ms, no buttons, backdrop true.

```php
<?php

/*
 * For more details about the configuration, see:
 * https://sweetalert2.github.io/#configuration
 */

use Jantinnerezo\LivewireAlert\Enums\Position;

return [
    'position' => Position::Center,
    'timer' => 3000,
    'toast' => false,
    'text' => null,
    'confirmButtonText' => 'Yes',
    'cancelButtonText' => 'Cancel',
    'denyButtonText' => 'No',
    'showCancelButton' => false,
    'showConfirmButton' => false,
    'backdrop' => true,
];
```

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

### LivewireAlert facade static method signatures

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/facade.md

Lists the static methods declared in the facade's @method docblock. Each method returns \Jantinnerezo\LivewireAlert\LivewireAlert unless noted. The docblock omits non-chainable methods like getOptions(), getEvents(), show(), close(), and update(), but they remain callable statically because the facade is a transparent proxy.

```php
title(string $title)
text(string $text)
success()
error()
warning()
info()
question()
position(string $position)
toast(bool $toast = true)
timer(int|null $timer)
html(string | \Closure $value)
allowOutsideClick(bool | \Closure $allowed = true)
allowEscapeKey(bool | \Closure $allowed = true)
withConfirmButton(?string $confirmButtonText = null)
withCancelButton(?string $cancelButtonText = null)
withDenyButton(?string $denyButtonText = null)
confirmButtonText(string $text)
cancelButtonText(string $text)
denyButtonText(string $text)
confirmButtonColor(string $color)
cancelButtonColor(string $color)
denyButtonColor(string $color)
imageUrl(string $url)
imageWidth(int $width)
imageHeight(int $height)
imageAlt(string $alt)
timerProgressBar(bool $show = true)
asConfirm()
asToast()
customClass(array<string, string> $classes)
reverseButtons(bool $reverse = true)
withTextInput(?string $label = null, ?string $placeholder = null, ?string $value = null)
withEmailInput(?string $label = null, ?string $placeholder = null, ?string $value = null)
withPasswordInput(?string $label = null, ?string $placeholder = null)
withNumberInput(?string $label = null, ?string $placeholder = null, ?string $value = null)
withTextareaInput(?string $label = null, ?string $placeholder = null, ?string $value = null)
withSelectInput(array<string, string> $options = [], ?string $label = null, ?string $value = null)
withRadioInput(array<string, string> $options = [], ?string $label = null, ?string $value = null)
withCheckboxInput(?string $label = null, bool $checked = false)
withFileInput(?string $label = null)
onConfirm(string $action, mixed $data = null)
onDeny(string $action, mixed $data = null)
onDismiss(string $action, mixed $data = null)
withOptions(array<string, array<string, string>|string> $options = [])
```

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

### success/error/warning/info/question method signatures

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert.md

Each method takes no parameters and sets the icon option to the matching Enums\Icon backing value. Returns $this. Sources: src/LivewireAlert.php:42, :49, :56, :63, :70.

```php
public function success(): self
public function error(): self
public function warning(): self
public function info(): self
public function question(): self
```

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

### LivewireAlert::__construct

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert.md

Constructs a new LivewireAlert instance. Requires a Livewire component; throws an exception if null.

```APIDOC
## [CONSTRUCTOR] LivewireAlert::__construct

### Description
Constructs a new LivewireAlert instance bound to a specific Livewire component. The component is required to execute the generated JavaScript for SweetAlert2 alerts.

### Method
CONSTRUCTOR

### Parameters
#### Constructors
- **$component** (\Livewire\Component|): Required - The Livewire component that will execute the generated JS. Must not be null; otherwise an exception is thrown.

### Request Example
```php
new LivewireAlert($this); // $this = current Livewire\Component
```

### Response
#### Throws
- **\Exception** - Thrown when `$component` is null, with message 'LivewireAlert requires a Livewire component context.'

```

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

### LivewireAlert asLoading signature

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-presets.md

Signature for the asLoading preset method. Optional $title parameter (defaults to 'Loading…'). Sets options: title, allowOutsideClick to false, allowEscapeKey to false, showConfirmButton to false, showCancelButton to false, showDenyButton to false, didOpen to the JS string '() => Swal.showLoading()', and timer to null. Returns $this.

```php
public function asLoading(?string $title = null): self

```

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

### LivewireAlert::withOptions()

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/facade.md

Sets additional options for the alert. This is a chainable method that returns the LivewireAlert instance.

```APIDOC
## LivewireAlert::withOptions(array<string, array<string, string>|string> $options = [])

### Description
Sets additional options for the alert. This is a chainable method that returns the LivewireAlert instance.

### Method
STATIC

### Endpoint
LivewireAlert::withOptions(array<string, array<string, string>|string> $options = [])

### Parameters
- **$options** (array<string, array<string, string>|string>) - Optional - An associative array of options.

### Response
Returns \Jantinnerezo\LivewireAlert\LivewireAlert (chainable).
```

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

### register() method signature

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/service-provider.md

Register method signature, performs container bindings and config merge.

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

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

### getOptions() merge logic

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/configuration.md

LivewireAlert::getOptions() computes the final SweetAlert2 payload. Config values act as defaults that any fluent setter overrides per alert.

```php
array_merge(
    config('livewire-alert'),            // every key above, as the base
    array_intersect_key(                 // then explicit per-alert options
        $this->options,
        array_flip(Enums\Option::values())
    ),
)
```

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

### Import SweetAlert2 in app.js

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/README.md

Imports SweetAlert2 and exposes it globally as window.Swal in resources/js/app.js.

```js
import Swal from 'sweetalert2'

window.Swal = Swal
```

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

### Quick taste: LivewireAlert facade

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/README.md

Shows the fluent facade API: LivewireAlert::title('Changes saved!')->success()->show(). Place inside a Livewire component method.

```php
use Jantinnerezo\LivewireAlert\Facades\LivewireAlert;

public function save()
{
    LivewireAlert::title('Changes saved!')
        ->success()
        ->show();
}
```

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

### Run package tests

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/README.md

Runs the package's test suite via Composer.

```bash
composer test
```

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

### imageAlt method signature

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-images.md

Method signature for setting the imageAlt option. Accepts a string for the alt text and returns an Alertable instance.

```php
public function imageAlt(string $alt): Alertable
```

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

### getOptions method and its implementation

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-images.md

The getOptions method returns the resolved SweetAlert2 options array. It merges all configured defaults from config/livewire-alert.php with internally set options whose keys are valid Enums\Option values. Options with keys outside the enum are dropped.

```php
/** @return array<Enums\Option, mixed> */
public function getOptions(): array
```

```php
array_merge(
    config('livewire-alert'),
    array_intersect_key($this->options, array_flip(Enums\Option::values())),
)
```

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

### LivewireAlert::asConfirm()

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/facade.md

Configures the alert as a confirmation dialog. This is a chainable method that returns the LivewireAlert instance.

```APIDOC
## LivewireAlert::asConfirm()

### Description
Configures the alert as a confirmation dialog. This is a chainable method that returns the LivewireAlert instance.

### Method
STATIC

### Endpoint
LivewireAlert::asConfirm()

### Parameters
None.

### Response
Returns \Jantinnerezo\LivewireAlert\LivewireAlert (chainable).
```

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

### getOptions(): array

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-images.md

Returns the resolved SweetAlert2 options array by merging all configured defaults from config/livewire-alert.php with internally set options whose keys are valid Enums\Option values. Options with keys outside the enum are dropped.

```APIDOC
## getOptions(): array

### Description
Returns the resolved SweetAlert2 options array. The result is a merge of all configured defaults from `config/livewire-alert.php` and the internally set options whose keys are valid `Enums\Option` values. Options set with keys outside the enum are dropped.

### Method
PHP method

### Endpoint
`LivewireAlert::getOptions()`

### Parameters
None

### Return Value
- **array<Enums\Option, mixed>** - The merged options array.

### Example
```php
$options = $component->getOptions();
```
```

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

### registerPublishables() method signature

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/service-provider.md

Method signature that publishes config only in console.

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

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

### LivewireAlert::getOptions()

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/facade.md

Retrieves the options of the alert. This method is non-chainable and executes on the resolved instance.

```APIDOC
## LivewireAlert::getOptions()

### Description
Retrieves the options of the alert. This method is non-chainable and executes on the resolved instance.

### Method
STATIC

### Endpoint
LivewireAlert::getOptions()

### Parameters
None.

### Response
Returns the options array.
```

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

### asConfirm(): self

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-buttons.md

Composes a confirmation dialog by applying the question icon, enabling confirm and deny buttons with configured text, and disabling the auto-close timer. Returns the instance for chaining.

```APIDOC
## asConfirm(): self

### Description
Composes a confirmation dialog: applies `question()` icon, enables the confirm button with `config('livewire-alert.confirmButtonText')` and the deny button with `config('livewire-alert.denyButtonText')`, and disables the auto-close timer (`timer => null`). Returns `$this` for chaining.

### Method
`asConfirm`

### Parameters
None.

### Returns
`$this` - The current LivewireAlert instance for method chaining.

### Example
```php
LivewireAlert::title('Are you sure?')
    ->text('This cannot be undone.')
    ->asConfirm()
    ->onConfirm('destroy')        // see livewire-alert-presets.md
    ->onDeny('keep')
    ->show();
```

### Source
`src/LivewireAlert.php:260`
```

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

### withConfirmButton

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-buttons.md

Sets the confirm button text and enables the confirm button. Falls back to the configured default if no text is provided.

```APIDOC
## withConfirmButton

### Description
Sets `showConfirmButton` to `true` and `confirmButtonText` to the provided text or the configured default.

### Method
withConfirmButton

### Signature
public function withConfirmButton(?string $confirmButtonText = null): self

### Parameters
- **$confirmButtonText** (string|null) - Optional - Confirm button label; falls back to `config('livewire-alert.confirmButtonText')`

### Return Value
Returns `$this` for chaining.

### Behavior
Sets `showConfirmButton` to `true` and `confirmButtonText` (to the argument, or to the configured default `'Yes'`).
```

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

### withSelectInput

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-inputs.md

Method to configure a select input for the alert.

```APIDOC
## withSelectInput

### Description
Sets the alert input type to `'select'` with options, label, and value. The `inputOptions` property is always set, even when `$options` is empty.

### Method
`withSelectInput`

### Signature
```php
/** @param array<string, string> $options */
public function withSelectInput(array $options = [], ?string $label = null, ?string $value = null): self
```

### Parameters
- `$options` (array<string,string>) - Optional - Default `[]` - Maps option value to display label; sets `inputOptions`.
- `$label` (string|null) - Optional - Default `null` - Sets `inputLabel` when not null.
- `$value` (string|null) - Optional - Default `null` - Sets `inputValue` when not null.

### Return Value
`self` - Returns the instance for chaining.

### Source
`src/LivewireAlert.php:397`
```

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

### withFileInput

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-inputs.md

Sets the alert input type to 'file' and optionally sets the input label.

```APIDOC
## withFileInput

### Description
Sets the alert input type to `file` and optionally sets the input label.

### Method
`withFileInput`

### Signature
```php
public function withFileInput(?string $label = null): self
```

### Parameters
- **$label** (string|null) - Optional - Sets `inputLabel` when not null.

### Returns
`self` - The current instance for method chaining.

### Source
`src/LivewireAlert.php:427`
```

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

### LivewireAlert::withFileInput()

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/facade.md

Adds a file input to the alert. This is a chainable method that returns the LivewireAlert instance.

```APIDOC
## LivewireAlert::withFileInput(?string $label = null)

### Description
Adds a file input to the alert. This is a chainable method that returns the LivewireAlert instance.

### Method
STATIC

### Endpoint
LivewireAlert::withFileInput(?string $label = null)

### Parameters
- **$label** (?string) - Optional - The label for the file input.

### Response
Returns \Jantinnerezo\LivewireAlert\LivewireAlert (chainable).
```

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

### Container bindings and config merge in register()

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/service-provider.md

Registers two container bindings and merges config; binds concrete class and alias to current Livewire component, requires Livewire context.

```php
$this->app->bind(LivewireAlert::class, function ($app) {
    return new LivewireAlert($app['livewire']->current());
});

$this->app->bind('livewire-alert', function ($app) {
    return new LivewireAlert($app['livewire']->current());
});

$this->mergeConfigFrom(
    __DIR__ . '/../config/livewire-alert.php',
    'livewire-alert'
);
```

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

### LivewireAlert facade accessor

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/facade.md

Defines the facade accessor that returns the container binding key 'livewire-alert'. The service provider binds this key to a fresh LivewireAlert instance constructed with the current Livewire component, so static calls are forwarded to that instance.

```php
class LivewireAlert extends Facade
{
    protected static function getFacadeAccessor()
    {
        return 'livewire-alert';
    }
}
```

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

### withFileInput method signature

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-inputs.md

Define the withFileInput method signature, setting input to 'file'. Use to add a file input to an alert, optionally setting a label.

```php
public function withFileInput(?string $label = null): self
```

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

### LivewireAlert asToast signature

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-presets.md

Signature for the asToast preset method. No parameters. Composes a toast preset, setting toast to true (and therefore backdrop to false), position to Enums\Position::TopEnd ('top-end'), timer to config('livewire-alert.timer') (default 3000), and timerProgressBar to true. Returns $this.

```php
public function asToast(): self

```

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

### withTextareaInput

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-inputs.md

Method to configure a textarea input for the alert.

```APIDOC
## withTextareaInput

### Description
Sets the alert input type to `'textarea'` with optional label, placeholder, and value. Same parameters as `withTextInput`.

### Method
`withTextareaInput`

### Signature
```php
public function withTextareaInput(?string $label = null, ?string $placeholder = null, ?string $value = null): self
```

### Parameters
- `$label` (?string) - Optional - Sets `inputLabel` when not null.
- `$placeholder` (?string) - Optional - Sets `inputPlaceholder` when not null.
- `$value` (?string) - Optional - Sets `inputValue` when not null.

### Return Value
`self` - Returns the instance for chaining.

### Source
`src/LivewireAlert.php:386`
```

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

### withRadioInput

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-inputs.md

Method to configure a radio input for the alert.

```APIDOC
## withRadioInput

### Description
Sets the alert input type to `'radio'` with options, label, and value. Identical contract to `withSelectInput`.

### Method
`withRadioInput`

### Signature
```php
/** @param array<string, string> $options */
public function withRadioInput(array $options = [], ?string $label = null, ?string $value = null): self
```

### Parameters
- `$options` (array<string,string>) - Optional - Default `[]` - Maps option value to display label; sets `inputOptions`.
- `$label` (string|null) - Optional - Default `null` - Sets `inputLabel` when not null.
- `$value` (string|null) - Optional - Default `null` - Sets `inputValue` when not null.

### Return Value
`self` - Returns the instance for chaining.

### Source
`src/LivewireAlert.php:408`
```

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

### show

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-presets.md

Snapshot-renders the alert by reading options and events, then delegating to the trait's alert() method to build and execute the JavaScript that fires the SweetAlert2 modal.

```APIDOC
## show

### Description
Snapshot-renders the alert by reading `getOptions()` and `getEvents()`, then delegating to the trait's `alert()` method, which builds the JavaScript and hands it to `$this->component->js($js)`. The JS `await`s `Swal.fire(options)`; if `typeof Swal === 'undefined'` it logs a warning to the console and returns.

### Method
show

### Endpoint
`LivewireAlert::show()`

### Parameters
None.

### Return Value
`void`

### Notes
- Idempotent per rendered payload; chaining more setters after it and calling `show()` again renders a second alert.
- Source: `src/LivewireAlert.php:464`
- Generated JS in `SweetAlert2::alert()`.
```

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

### confirmButtonColor, cancelButtonColor, denyButtonColor method signatures

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-buttons.md

Method signatures for setting the CSS color of the confirm, cancel, and deny buttons. Accepts a CSS color string (hex, rgb, named). Each returns $this for chaining.

```php
public function confirmButtonColor(string $color): self
public function cancelButtonColor(string $color): self
public function denyButtonColor(string $color): self
```

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

### Per-call overrides with LivewireAlert

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/configuration.md

Per-call overrides: defaults produce an alert with no buttons; timer(6000) and withConfirmButton('OK') override individual keys; asToast() uses the config timer default of 3000ms.

```php
// defaults: position center, timer 3000ms, no buttons
LivewireAlert::title('Default-ish')
    ->show();

// override individual keys per alert:
LivewireAlert::title('Slow')
    ->timer(6000)
    ->withConfirmButton('OK')
    ->show();

// asToast() reads the timer default:
LivewireAlert::title('Quick note')
    ->success()
    ->asToast()   // timer => config('livewire-alert.timer') => 3000
    ->show();
```

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

### LivewireAlert::toast()

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/facade.md

Sets the alert to display as a toast. This is a chainable method that returns the LivewireAlert instance.

```APIDOC
## LivewireAlert::toast(bool $toast = true)

### Description
Sets the alert to display as a toast. This is a chainable method that returns the LivewireAlert instance.

### Method
STATIC

### Endpoint
LivewireAlert::toast(bool $toast = true)

### Parameters
- **$toast** (bool) - Optional - Whether to display as a toast. Defaults to true.

### Response
Returns \Jantinnerezo\LivewireAlert\LivewireAlert (chainable).
```

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

### Inject Alertable contract in constructor

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/alertable.md

Shows how to inject the Alertable contract into a class constructor to use LivewireAlert as a dependency. The comment notes that the container resolves it to LivewireAlert. The saved() method demonstrates chaining title(), success(), and show() to display an alert.

```php
use Jantinnerezo\LivewireAlert\Contracts\Alertable;

class Notify
{
    public function __construct(
        private Alertable $alert,   // resolves to LivewireAlert from the container
    ) {}

    public function saved(): void
    {
        $this->alert->title('All good')->success()->show();
    }
}
```

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

### LivewireAlert::asToast()

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/facade.md

Configures the alert as a toast notification. This is a chainable method that returns the LivewireAlert instance.

```APIDOC
## LivewireAlert::asToast()

### Description
Configures the alert as a toast notification. This is a chainable method that returns the LivewireAlert instance.

### Method
STATIC

### Endpoint
LivewireAlert::asToast()

### Parameters
None.

### Response
Returns \Jantinnerezo\LivewireAlert\LivewireAlert (chainable).
```

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

### LivewireAlert::question()

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/facade.md

Sets the alert type to question. This is a chainable method that returns the LivewireAlert instance.

```APIDOC
## LivewireAlert::question()

### Description
Sets the alert type to question. This is a chainable method that returns the LivewireAlert instance.

### Method
STATIC

### Endpoint
LivewireAlert::question()

### Parameters
None.

### Response
Returns \Jantinnerezo\LivewireAlert\LivewireAlert (chainable).
```

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

### LivewireAlert constructor signature

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert.md

Constructor signature for LivewireAlert. Accepts an optional Livewire Component; if null, the constructor throws an exception.

```php
public function __construct(protected ?Component $component)
```

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

### html

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert.md

Sets the HTML body of the alert, either as a raw string or via a closure returning a string.

```APIDOC
## html(string|\Closure $value)

### Description
Sets the HTML content for the alert body. Accepts a raw HTML string or a closure that must return a string. If a closure is provided, it is invoked immediately; a non-string return value throws an exception. Returns the current instance for chaining.

### Method
`html` (method on `LivewireAlert`)

### Parameters
- `$value` (string|\Closure) - Required - Raw HTML for the alert body, or a closure that must return a string.

### Returns
- `self` - The current `LivewireAlert` instance for method chaining.

### Exceptions
- `\Exception` - Thrown if the closure does not return a string.

### Examples
```php
LivewireAlert::title('Heads up')
    ->html('<em>Inline <strong>HTML</strong> body</em>')
    ->show();

LivewireAlert::title('Greeting')
    ->html(fn () => '<b>' . auth()->user()->name . '</b>') // closure form
    ->show();
```

```

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

### LivewireAlert::onConfirm()

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/facade.md

Sets the action to be called when the confirm button is clicked. This is a chainable method that returns the LivewireAlert instance.

```APIDOC
## LivewireAlert::onConfirm(string $action, mixed $data = null)

### Description
Sets the action to be called when the confirm button is clicked. This is a chainable method that returns the LivewireAlert instance.

### Method
STATIC

### Endpoint
LivewireAlert::onConfirm(string $action, mixed $data = null)

### Parameters
- **$action** (string) - Required - The Livewire action to call.
- **$data** (mixed) - Optional - Data to pass to the action.

### Response
Returns \Jantinnerezo\LivewireAlert\LivewireAlert (chainable).
```

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

### Option::callbacks()

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/enums.md

Returns the subset of Option cases that represent JavaScript expressions evaluated client-side before being passed to Swal.fire or Swal.update.

```APIDOC
## Option::callbacks()

### Description
Returns the subset of Option cases that represent JavaScript expressions evaluated client-side before being passed to Swal.fire or Swal.update.

### Method
`public static function callbacks(): array`

### Return Value
- **array<self>** - An array of Option enum instances for the callback cases: AllowOutsideClick, AllowEscapeKey, AllowEnterKey, LoaderHtml, InputOptions, InputValidator, PreConfirm, PreDeny, DidClose, DidDestroy, DidOpen, DidRender, WillClose, WillOpen.

### Source
`src/Enums/Option.php:107`
```

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

### allowEscapeKey(bool|\Closure $allowed = true): self

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert.md

Allows dismissal with the Escape key. Accepts a boolean or a closure that must return a boolean, and returns the LivewireAlert instance for chaining.

```APIDOC
# allowEscapeKey

```php
public function allowEscapeKey(bool | \Closure $allowed = true): self
```

| Parameter | Type              | Required | Default | Description                                                                        |
|-----------|-------------------|----------|---------|------------------------------------------------------------------------------------|
| `$allowed`| bool \| `\Closure` | no       | `true`  | Allow dismissal with the Escape key; a closure **must return a bool**              |

Identical closure contract to `allowOutsideClick`; also a supported callback
option evaluated client-side. Returns `$this`. Source: `src/LivewireAlert.php:140`.

```

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

### LivewireAlert::info()

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/facade.md

Sets the alert type to info. This is a chainable method that returns the LivewireAlert instance.

```APIDOC
## LivewireAlert::info()

### Description
Sets the alert type to info. This is a chainable method that returns the LivewireAlert instance.

### Method
STATIC

### Endpoint
LivewireAlert::info()

### Parameters
None.

### Response
Returns \Jantinnerezo\LivewireAlert\LivewireAlert (chainable).
```

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

### LivewireAlert::show()

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/facade.md

Displays the alert on the current Livewire component. This method is non-chainable and executes the alert.

```APIDOC
## LivewireAlert::show()

### Description
Displays the alert on the current Livewire component. This method is non-chainable and executes the alert.

### Method
STATIC

### Endpoint
LivewireAlert::show()

### Parameters
None.

### Response
No return value (void).
```

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

### withNumberInput

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-inputs.md

Method to configure a number input for the alert.

```APIDOC
## withNumberInput

### Description
Sets the alert input type to `'number'` with optional label, placeholder, and value. Same parameters as `withTextInput`.

### Method
`withNumberInput`

### Signature
```php
public function withNumberInput(?string $label = null, ?string $placeholder = null, ?string $value = null): self
```

### Parameters
- `$label` (?string) - Optional - Sets `inputLabel` when not null.
- `$placeholder` (?string) - Optional - Sets `inputPlaceholder` when not null.
- `$value` (?string) - Optional - Sets `inputValue` when not null. Numeric strings expected.

### Return Value
`self` - Returns the instance for chaining.

### Source
`src/LivewireAlert.php:376`
```

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

### withDenyButton

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-buttons.md

Enables the deny button and sets its text, defaulting to the configured value. Returns the instance for chaining.

```APIDOC
## withDenyButton

### Description
Sets `showDenyButton` to `true` and `denyButtonText` (default `'No'`). Returns `$this`.

### Method
PHP

### Endpoint
`withDenyButton(?string $denyButtonText = null): self`

### Parameters
#### Parameters
- **$denyButtonText** (string|null) - Optional - Deny button label; falls back to `config('livewire-alert.denyButtonText')`

### Response
Returns `$this` for chaining.

### Example
```php
LivewireAlert::title('Delete account?')
    ->question()
    ->withDenyButton('Keep it')
    ->show();
```
```

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

### toast

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert.md

Configures whether the alert renders as a toast and automatically disables the backdrop.

```APIDOC
## toast(boolean $toast = true)

### Description
Sets whether the alert renders as a toast. Also sets the backdrop option to the opposite value (toasts never render a modal backdrop). Returns the current instance for chaining.

### Method
`toast` (method on `LivewireAlert`)

### Parameters
- `$toast` (bool) - Optional - Default `true` - Whether the alert renders as a toast.

### Returns
- `self` - The current `LivewireAlert` instance for method chaining.

```

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

### withOptions method signature

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-images.md

Method signature for withOptions. Accepts an array of options (Option enum values or plain strings) and returns $this.

```php
/** @param array<Enums\Option, mixed> $options */
public function withOptions(array $options = []): self
```

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

### Register onConfirm, onDeny, onDismiss callbacks

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-presets.md

Registers callback methods on the current Livewire component for the confirm, deny, and dismiss events. Each stores the action name and optional data payload under the corresponding event enum. Returns $this for chaining.

```php
public function onConfirm(string $action, mixed $data = null): self
public function onDeny(string $action, mixed $data = null): self
public function onDismiss(string $action, mixed $data = null): self
```

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

### timerProgressBar(bool $show = true): self

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-buttons.md

Renders a progress bar next to the auto-close timer. Sets the timerProgressBar option and returns the instance for chaining.

```APIDOC
## timerProgressBar(bool $show = true): self

### Description
Renders a progress bar next to the auto-close timer. Sets the `timerProgressBar` option and returns `$this` for chaining. Only meaningful when a `timer` is configured.

### Method
`timerProgressBar`

### Parameters
- `$show` (bool) - Optional - Default: `true` - Render a progress bar next to the auto-close timer.

### Returns
`$this` - The current LivewireAlert instance for method chaining.

### Source
`src/LivewireAlert.php:300`
```

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

### Resolving LivewireAlert from container

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/service-provider.md

Shows how to resolve the service both by class name and alias; throws \Exception('LivewireAlert requires a Livewire component context.') outside Livewire request.

```php
use Jantinnerezo\LivewireAlert\LivewireAlert;

// both resolve to a LivewireAlert bound to the current Livewire component
app(LivewireAlert::class);
app('livewire-alert');
```

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

### LivewireAlert::withEmailInput()

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/facade.md

Adds an email input field to the alert. This is a chainable method that returns the LivewireAlert instance.

```APIDOC
## LivewireAlert::withEmailInput(?string $label = null, ?string $placeholder = null, ?string $value = null)

### Description
Adds an email input field to the alert. This is a chainable method that returns the LivewireAlert instance.

### Method
STATIC

### Endpoint
LivewireAlert::withEmailInput(?string $label = null, ?string $placeholder = null, ?string $value = null)

### Parameters
- **$label** (?string) - Optional - The label for the input.
- **$placeholder** (?string) - Optional - The placeholder text.
- **$value** (?string) - Optional - The default value.

### Response
Returns \Jantinnerezo\LivewireAlert\LivewireAlert (chainable).
```

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

### Include SweetAlert2 via CDN

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/README.md

Adds SweetAlert2 from jsDelivr CDN before the closing </body> tag.

```html
<script src="https://cdn.jsdelivr.net/npm/sweetalert2@11"></script>
```

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

### reverseButtons(): Swap confirm/deny/cancel button order

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert-buttons.md

Method signature for swapping the visual order of confirm/deny/cancel buttons. Sets the reverseButtons option and returns $this for chaining.

```php
public function reverseButtons(bool $reverse = true): self
```

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

### html method signature

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/livewire-alert.md

Sets the html option to the given raw HTML string or closure. If a closure is passed, it is invoked immediately and must return a string; otherwise an exception is thrown. Returns $this.

```php
public function html(string | \Closure $value): self
```

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

### Alertable Contract

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/alertable.md

This is a contract specification (Alertable interface) rather than a directly callable API. It describes requirements for implementers, not an interface users call directly. Per the instructions, this is treated as internal documentation; no operations are extracted.

```APIDOC
## [API] Alertable Contract

### Description
This interface defines a fluent API for configuring alert notifications. Every configuration method returns the same builder instance (`self`). The implementing class `LivewireAlert` satisfies this contract. The interface has no default implementations or constants; all behavior is defined in the implementing class.

### Method
N/A

### Endpoint
N/A

### Parameters
No parameters.

### Request Example
No request example.

### Response
#### Success Response (200)
No response body.

#### Response Example
No response example.
```

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

### Conditional config publish in registerPublishables

Source: https://github.com/jantinnerezo/livewire-alert/blob/master/_autodocs/api-reference/service-provider.md

Publishes the package config file to the Laravel config directory when running in console, with tag 'livewire-alert:config'.

```php
if ($this->app->runningInConsole()) {
    $this->publishes([
        __DIR__ . '/../config/livewire-alert.php' => config_path('livewire-alert.php'),
    ], 'livewire-alert:config');
}
```
Tokens:
Raw