Skip to content
UI Brok

Loading…

No results

Browse catalog

Alert

Callout for short, important messages with semantic variants.

Preview

Controls

Variant
Theme
Surface
Direction
Viewport

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

Options

Visual options rendered from the current preview target.

Variant

Default
Destructive
Success
Warning
Info

Installation

terminal 
php artisan ui:add alert

Registry contract

Install confidence

php artisan ui:add alert 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.0
License
open
Stability
stable
Contract
v2
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/components/ui/alert.blade.php
blade resources/views/components/ui/alert/title.blade.php
blade resources/views/components/ui/alert/description.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Persistent message and notification

Keep an important message visible near its context.

Use when

  • Use for important messages that should stay visible long enough to read and act on. Do not downgrade important guidance into transient messaging users can miss.

Avoid when

  • Avoid using alert as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.
Task length
micro
Interaction cost
low
Interruptiveness
medium
Input precision
none
Mobile / touch risk
low
Accessibility risk
high
Needs background context
Yes
Comparison needed
No

Preferred alternatives

  • Toast for low-priority confirmation

Anti-patterns

  • Downgrading important outcomes to transient feedback

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
variant default|destructive|success|warning|info default Documented catalog control used by the preview workbench.

Slots

  • default — Primary Blade slot rendered by the component.
  • x-ui.alert.title — Installed subcomponent from the registry item.
  • x-ui.alert.description — Installed subcomponent from the registry item.

Data slots

alert alert-description alert-title

Capabilities

wcag-2.2-aa-target responsive rtl darkMode localized

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Usage

previews.components.alert.default.blade.php Blade 
<x-ui.alert class="w-full max-w-md text-start">
    <x-ui.alert.title>{{ __('Heads up') }}</x-ui.alert.title>
    <x-ui.alert.description>{{ __('You can add components to your app using the CLI.') }}</x-ui.alert.description>
</x-ui.alert>

Variants

previews.components.alert.variants.blade.php Blade 
<div class="w-full max-w-md space-y-3 text-start">
    <x-ui.alert>
        <x-ui.alert.title>{{ __('Default') }}</x-ui.alert.title>
        <x-ui.alert.description>{{ __('A neutral, informational message.') }}</x-ui.alert.description>
    </x-ui.alert>
    <x-ui.alert variant="success">
        <x-ui.alert.title>{{ __('Success') }}</x-ui.alert.title>
        <x-ui.alert.description>{{ __('Your changes have been saved.') }}</x-ui.alert.description>
    </x-ui.alert>
    <x-ui.alert variant="warning">
        <x-ui.alert.title>{{ __('Warning') }}</x-ui.alert.title>
        <x-ui.alert.description>{{ __('Your trial ends in three days.') }}</x-ui.alert.description>
    </x-ui.alert>
    <x-ui.alert variant="destructive">
        <x-ui.alert.title>{{ __('Error') }}</x-ui.alert.title>
        <x-ui.alert.description>{{ __('Something went wrong. Please try again.') }}</x-ui.alert.description>
    </x-ui.alert>
    <x-ui.alert variant="info">
        <x-ui.alert.title>{{ __('Info') }}</x-ui.alert.title>
        <x-ui.alert.description>{{ __('A new version is available.') }}</x-ui.alert.description>
    </x-ui.alert>
</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.0. See the site changelog for the full release history.