Preview

Install the package

Add the dependency to your project.
2

Configure the registry

Point the CLI at your registry endpoint.
3

Add your first component

Run ui:add to copy editable Blade in.

Cart
2

Shipping
3

Payment

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 stepper

Registry contract

Install confidence

php artisan ui:add stepper 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/stepper.blade.php
blade	resources/views/components/ui/stepper/item.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Progress and sequence

Communicate genuine progress or ordered stages.

Use when

Use to show real progress, ordered stages, or process status when visibility helps completion. Do not add progress UI to tiny tasks or to flows whose steps are not meaningfully sequential.

Avoid when

Use for ordered stages with clear progression; start complex flows as focused steps and merge only when research supports it.

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

Preferred alternatives

Simple completion text for tiny tasks

Anti-patterns

Decorative or inaccurate progress
Steppers for nonsequential exploration

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
orientation	string	vertical	Declared by @props in the registry Blade source.
steps	array	[]	Declared by @props in the registry Blade source.
step	mixed\|null	null	Declared by @props in the registry Blade source.
title	mixed\|null	null	Declared by @props in the registry Blade source.
description	mixed\|null	null	Declared by @props in the registry Blade source.
status	string	default	Declared by @props in the registry Blade source.
icon	mixed\|null	null	Declared by @props in the registry Blade source.
last	bool	false	Declared by @props in the registry Blade source.

Slots

default — Primary Blade slot rendered by the component.
x-ui.stepper.item — Installed subcomponent from the registry item.

Data slots

stepper stepper-connector stepper-content stepper-description stepper-item stepper-marker stepper-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.stepper.default.blade.php Blade

<div class="grid w-full gap-10 lg:grid-cols-2">
    <x-ui.stepper
        :steps="[
            ['title' => 'Install the package', 'description' => 'Add the dependency to your project.', 'status' => 'completed'],
            ['title' => 'Configure the registry', 'description' => 'Point the CLI at your registry endpoint.', 'status' => 'active'],
            ['title' => 'Add your first component', 'description' => 'Run ui:add to copy editable Blade in.', 'status' => 'default'],
        ]"
    />

    <x-ui.stepper orientation="horizontal" class="self-start">
        <x-ui.stepper.item step="1" title="Cart" status="completed" />
        <x-ui.stepper.item step="2" title="Shipping" status="active" />
        <x-ui.stepper.item step="3" title="Payment" status="default" :last="true" />
    </x-ui.stepper>
</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.

Timeline