Skip to content
UI Brok

Loading…

No results

Browse catalog

Item

Flexible horizontal layout for list rows with media, content and actions.

Preview

Project Alpha
Updated 2 hours ago

Controls

Disabled
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 item

Registry contract

Install confidence

php artisan ui:add item 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.2.0
License
open
Stability
stable
Contract
v2
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/components/ui/item.blade.php
blade resources/views/components/ui/item/group.blade.php
blade resources/views/components/ui/item/media.blade.php
blade resources/views/components/ui/item/content.blade.php
blade resources/views/components/ui/item/title.blade.php
blade resources/views/components/ui/item/description.blade.php
blade resources/views/components/ui/item/actions.blade.php
blade resources/views/components/ui/item/separator.blade.php

Registry dependencies

separator

Package dependencies

composer: jml/brok:^1.0

Guidance

Card-based organization

Organize browsable objects into scannable units.

Use when

  • Use to group related content into scannable units for browsing, prioritization, or rearrangement. Do not use card-like structures when dense row-by-row comparison would be clearer in a list or table.

Avoid when

  • Avoid using item 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
short
Interaction cost
medium
Interruptiveness
none
Input precision
none
Mobile / touch risk
medium
Accessibility risk
medium
Needs background context
No
Comparison needed
Yes

Preferred alternatives

  • Table for exact comparison
  • List for compact scanning

Anti-patterns

  • Turning every object into a card
Related: separator

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
disabled false|true false Documented catalog control used by the preview workbench.
variant string default Declared by @props in the registry Blade source.
size string default Declared by @props in the registry Blade source.
href mixed|null null Declared by @props in the registry Blade source.
clickable bool false Declared by @props in the registry Blade source.
active bool false Declared by @props in the registry Blade source.

Slots

  • default — Primary Blade slot rendered by the component.
  • x-ui.item.group — Installed subcomponent from the registry item.
  • x-ui.item.media — Installed subcomponent from the registry item.
  • x-ui.item.content — Installed subcomponent from the registry item.
  • x-ui.item.title — Installed subcomponent from the registry item.
  • x-ui.item.description — Installed subcomponent from the registry item.
  • x-ui.item.actions — Installed subcomponent from the registry item.
  • x-ui.item.separator — Installed subcomponent from the registry item.

Data slots

item item-actions item-content item-description item-group item-media item-separator item-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.item.default.blade.php Blade
<x-ui.item variant="outline">
    <x-ui.item.media variant="icon">
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">
            <path d="M2 7a2 2 0 0 1 2-2h5l2 2h9a2 2 0 0 1 2 2v9a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2z" />
        </svg>
    </x-ui.item.media>

    <x-ui.item.content>
        <x-ui.item.title>{{ __('Project Alpha') }}</x-ui.item.title>
        <x-ui.item.description>{{ __('Updated 2 hours ago') }}</x-ui.item.description>
    </x-ui.item.content>

    <x-ui.item.actions>
        <x-ui.button variant="outline" size="sm">{{ __('View') }}</x-ui.button>
    </x-ui.item.actions>
</x-ui.item>

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.2.0. See the site changelog for the full release history.