Preview

Controls

Theme

Surface

Direction

Viewport

Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.

Installation

terminal

php artisan ui:add toast

Behavior layer (Alpine)

This component installs a self-registering Alpine module to resources/js/ui/toast.js. Import the behavior layer once from your bundle so it loads (it hooks alpine:init):

resources/js/ui/index.js JS

import './toast.js';

Registry contract

Install confidence

php artisan ui:add toast writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version: 1.0.1
License: open
Stability: stable
Contract: v2
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/components/ui/toaster.blade.php
js	resources/js/ui/toast.js

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Transient feedback

Confirm a low-priority outcome transiently.

Use when

Use for low-priority transient confirmations that support the current task. Do not rely on transient messaging for critical outcomes users must not miss.

Avoid when

Reserve for low-priority transient feedback rather than outcomes users must reliably notice.

Task length: micro
Interaction cost: low
Interruptiveness: low
Input precision: none
Mobile / touch risk: medium
Accessibility risk: high
Needs background context: Yes
Comparison needed: No

Preferred alternatives

Inline alert
Persistent banner for important outcomes

Anti-patterns

Destructive warnings or validation errors in toasts

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
position	string	bottom-end	Declared by @props in the registry Blade source.

Slots

x-ui.toaster — Installed subcomponent from the registry item.

Data slots

toast toast-close toaster

Capabilities

wcag-2.2-aa-target interactive responsive rtl darkMode localized

Behavior

Uses server-rendered Blade and semantic HTML.
Installs a JavaScript behavior module when the registry item includes resources/js/ui files.
Declares registry capability flags: a11y, interactive, responsive, rtl, darkMode, localized.

Usage

previews.components.toast.default.blade.php Blade

<div class="flex flex-wrap items-center gap-3">
    <x-ui.button @click="window.toast({ title: '{{ __('Saved') }}', message: '{{ __('Your changes have been saved.') }}', variant: 'success' })">
        {{ __('Success toast') }}
    </x-ui.button>

    <x-ui.button variant="destructive" @click="window.toast({ title: '{{ __('Error') }}', message: '{{ __('Something went wrong.') }}', variant: 'destructive' })">
        {{ __('Error toast') }}
    </x-ui.button>

    <x-ui.button variant="outline" @click="window.toast('{{ __('A plain notification.') }}')">
        {{ __('Plain toast') }}
    </x-ui.button>

    {{-- Mount the live region once per page (here, scoped to the preview). --}}
    <x-ui.toaster />
</div>

Accessibility & localization

WCAG 2.2 AA RTL-ready data-slot Keyboard focus-visible Localized labels

Accessibility target: wcag-2.2-aa-target.
Uses semantic HTML and a stable data-slot attribute for styling/scripting hooks.
Focus-visible rings use the ring token so keyboard focus is always visible.
Disabled and invalid states are conveyed to assistive tech, not by color alone.
Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces above.
Labels go through __() and the component uses logical properties (ms-*, text-start, start-*) so it mirrors correctly — flip the preview to RTL to confirm.

Source

The exact, editable file ui:add writes into your app — copy it or own the whole thing. Previews render this same code; there are no preview-only components.

Changelog

Current version: v1.0.1. See the site changelog for the full release history.

Toast