Skip to content
UI Brok

Loading…

No results

Browse catalog

Breadcrumb

Path to the current resource as a hierarchy of links.

Preview

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 breadcrumb

Registry contract

Install confidence

php artisan ui:add breadcrumb 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/breadcrumb.blade.php
blade resources/views/components/ui/breadcrumb/list.blade.php
blade resources/views/components/ui/breadcrumb/item.blade.php
blade resources/views/components/ui/breadcrumb/link.blade.php
blade resources/views/components/ui/breadcrumb/page.blade.php
blade resources/views/components/ui/breadcrumb/separator.blade.php
blade resources/views/components/ui/breadcrumb/ellipsis.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Navigation and orientation

Orient users and move between destinations.

Use when

  • Use to orient users and help them move across pages, sections, or commands. Do not hide primary wayfinding in novelty interactions or deep nested structures if straightforward navigation would be clearer.

Avoid when

  • Avoid using breadcrumb 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
medium
Needs background context
No
Comparison needed
No

Preferred alternatives

  • Visible links and local navigation

Anti-patterns

  • Hiding primary wayfinding in novelty interactions

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
href string # Declared by @props in the registry Blade source.

Slots

  • default — Primary Blade slot rendered by the component.
  • x-ui.breadcrumb.list — Installed subcomponent from the registry item.
  • x-ui.breadcrumb.item — Installed subcomponent from the registry item.
  • x-ui.breadcrumb.link — Installed subcomponent from the registry item.
  • x-ui.breadcrumb.page — Installed subcomponent from the registry item.
  • x-ui.breadcrumb.separator — Installed subcomponent from the registry item.
  • x-ui.breadcrumb.ellipsis — Installed subcomponent from the registry item.

Data slots

breadcrumb breadcrumb-ellipsis breadcrumb-item breadcrumb-link breadcrumb-list breadcrumb-page breadcrumb-separator

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.breadcrumb.default.blade.php Blade 
<x-ui.breadcrumb>
    <x-ui.breadcrumb.list>
        <x-ui.breadcrumb.item>
            <x-ui.breadcrumb.link href="#">{{ __('Home') }}</x-ui.breadcrumb.link>
        </x-ui.breadcrumb.item>
        <x-ui.breadcrumb.separator />
        <x-ui.breadcrumb.item>
            <x-ui.breadcrumb.link href="#">{{ __('Components') }}</x-ui.breadcrumb.link>
        </x-ui.breadcrumb.item>
        <x-ui.breadcrumb.separator />
        <x-ui.breadcrumb.item>
            <x-ui.breadcrumb.page>{{ __('Breadcrumb') }}</x-ui.breadcrumb.page>
        </x-ui.breadcrumb.item>
    </x-ui.breadcrumb.list>
</x-ui.breadcrumb>

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.