Toasts

A toast is a short notification the client shows and dismisses. Toasts are raised on the server and carry a Variant — Success, Info, Warning, or Error — that styles them.

From an action

The most common source is an action. Add a toast to the ActionResult it returns; the variant can come first or second:

return ActionResult::success()
    ->toast('Product archived.')                       // defaults to Success
    ->toast(Variant::Error, 'Could not reach the warehouse.');

See Effects & results for the full effect list.

Flashing from outside an action

To show a toast after a controller redirect, from a listener, middleware, or anywhere an ActionResult is not available, use Effects::flash():

use Lattice\Lattice\Effects\Effect;
use Lattice\Lattice\Core\Enums\Variant;
use Lattice\Lattice\Facades\Effects;

public function handle(Request $request): Response
{
    $this->validate($request);
    // … persist …

    Effects::flash(Effect::toast(Variant::Success, 'Profile saved.'));

    return redirect('/profile');
}

The flashed toast is stored in the latticeEffects session bag, delivered with the next Inertia response, and shown once. Effects::flash() accepts any number of effects — toast, callout, and more — see Effects & results for details.

Building a message directly

Both paths wrap a ToastMessage value object. Build one explicitly to set a lifetime, control dismissal, or attach an action, then pass it to ->toast() (or Effect::toast()):

use Lattice\Lattice\Core\Values\ToastMessage;

return ActionResult::success()->toast(
    ToastMessage::make(Variant::Success, 'Product archived.')
        ->duration(8000)                       // auto-dismiss after 8s (default 4000ms)
        ->link('View products', '/products'),  // a link rendered in the toast
);

The builder options:

Method	Effect
->duration($ms)	Auto-dismiss after $ms milliseconds (default 4000).
->persistent()	Never auto-dismiss; the toast stays until it is closed.
->dismissible(false)	Hide the close button.
->link($label, $href, $method)	Render a link in the toast ($method defaults to HttpMethod::Get).
->action($component)	Render an action instead of a link — e.g. an Action that opens a confirm dialog or modal form.

Rendering

Toasts render through the <Toaster> the Lattice Provider mounts by default, anchored bottom center and dismissing each after its duration. Pass toaster={false} to the Provider to opt out and mount your own.