Preview

Development Mode

Controls

Variant

Size

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

Warning

Info

Destructive

Success

Muted

Primary

Accent

Size

Xs

Sm

Md

Lg

Installation

terminal

php artisan ui:add system-banner

Registry contract

Install confidence

php artisan ui:add system-banner 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.1.0
License: open
Stability: stable
Contract: v2
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/components/ui/system-banner.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 system-banner 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	warning\|info\|destructive\|success\|muted\|primary\|accent	warning	Documented catalog control used by the preview workbench.
size	xs\|sm\|md\|lg	xs	Documented catalog control used by the preview workbench.
text	string	Development Mode	Declared by @props in the registry Blade source.
show	bool	true	Declared by @props in the registry Blade source.
fixed	bool	true	Declared by @props in the registry Blade source.
icon	bool	false	Declared by @props in the registry Blade source.
dismissible	bool	false	Declared by @props in the registry Blade source.
align	string	center	Declared by @props in the registry Blade source.
role	string	status	Declared by @props in the registry Blade source.

Slots

default — Primary Blade slot rendered by the component.

Data slots

system-banner system-banner-dismiss

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.system-banner.default.blade.php Blade

<x-ui.system-banner :fixed="false" :text="__('Development Mode')" class="rounded-md" />

Variants

Staging environment

Read-only mode

Incident in progress

All migrations applied

previews.components.system-banner.variants.blade.php Blade

<div class="flex w-full flex-col gap-2">
    <x-ui.system-banner :fixed="false" variant="warning" size="sm" :text="__('Staging environment')" class="rounded-md" />
    <x-ui.system-banner :fixed="false" variant="info" size="sm" :text="__('Read-only mode')" class="rounded-md" />
    <x-ui.system-banner :fixed="false" variant="destructive" size="sm" :text="__('Incident in progress')" class="rounded-md" />
    <x-ui.system-banner :fixed="false" variant="success" size="sm" :text="__('All migrations applied')" class="rounded-md" />
</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.1.0. See the site changelog for the full release history.

System Banner