Preview

Online Busy Away Offline Neutral

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

Online

Busy

Away

Offline

Neutral

Installation

terminal

php artisan ui:add status

Registry contract

Install confidence

php artisan ui:add status 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/status.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Status and lightweight feedback

Communicate concise object or system state.

Use when

Use to show state, status, notification, or lightweight social feedback near the relevant object. Do not overload small status elements with explanations that should remain visible in text.

Avoid when

Avoid using status 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: none
Input precision: none
Mobile / touch risk: low
Accessibility risk: high
Needs background context: Yes
Comparison needed: No

Preferred alternatives

Persistent explanatory text

Anti-patterns

Using color or icon alone to communicate state

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
variant	online\|busy\|away\|offline\|neutral	online	Documented catalog control used by the preview workbench.
label	mixed\|null	null	Declared by @props in the registry Blade source.
pulse	bool	false	Declared by @props in the registry Blade source.
size	string	md	Declared by @props in the registry Blade source.

Slots

Components use the default Blade slot unless a documented subcomponent is installed by the registry item.

Data slots

status status-dot status-dot-ping status-label

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

<div class="flex flex-wrap items-center gap-6">
    <x-ui.status variant="online"  label="{{ __('Online') }}" />
    <x-ui.status variant="busy"    label="{{ __('Busy') }}" />
    <x-ui.status variant="away"    label="{{ __('Away') }}" />
    <x-ui.status variant="offline" label="{{ __('Offline') }}" />
    <x-ui.status variant="neutral" label="{{ __('Neutral') }}" />
</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.