Skip to content
UI Brok

Loading…

No results

Browse catalog

Label Selector

Selectable chips for single or multiple choice, submitting as native radios or checkboxes.

Preview

Primary topic

Interested topics

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 label-selector

Registry contract

Install confidence

php artisan ui:add label-selector 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.0.0
License
open
Stability
stable
Contract
v2
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/components/ui/label-selector.blade.php
blade resources/views/components/ui/label-selector/item.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Visible exclusive selection

Choose one option from a small visible set.

Use when

  • Use for a small set of mutually exclusive options that users should compare visibly before choosing. Do not hide a small option set in a dropdown when recognition and comparison matter.

Avoid when

  • Avoid using label-selector 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
constrained
Mobile / touch risk
low
Accessibility risk
medium
Needs background context
No
Comparison needed
Yes

Preferred alternatives

  • Select or combobox for long option sets

Anti-patterns

  • Hiding a small comparable set in a dropdown

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
disabled false|true false Documented catalog control used by the preview workbench.
name mixed required Declared by @props in the registry Blade source.
value mixed|null null Declared by @props in the registry Blade source.
multiple bool false Declared by @props in the registry Blade source.
options array [] Declared by @props in the registry Blade source.
checked bool false Declared by @props in the registry Blade source.

Slots

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

Data slots

label-selector label-selector-item

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.label-selector.default.blade.php Blade
<div class="space-y-6 text-start">
    <div class="space-y-2">
        <p class="text-sm font-medium text-foreground">{{ __('Primary topic') }}</p>
        <x-ui.label-selector name="preview-topic">
            <x-ui.label-selector.item value="design">{{ __('Design') }}</x-ui.label-selector.item>
            <x-ui.label-selector.item value="engineering" checked>{{ __('Engineering') }}</x-ui.label-selector.item>
            <x-ui.label-selector.item value="product">{{ __('Product') }}</x-ui.label-selector.item>
            <x-ui.label-selector.item value="marketing">{{ __('Marketing') }}</x-ui.label-selector.item>
            <x-ui.label-selector.item value="sales">{{ __('Sales') }}</x-ui.label-selector.item>
        </x-ui.label-selector>
    </div>

    <div class="space-y-2">
        <p class="text-sm font-medium text-foreground">{{ __('Interested topics') }}</p>
        <x-ui.label-selector name="preview-topics" multiple>
            <x-ui.label-selector.item value="design" checked>{{ __('Design') }}</x-ui.label-selector.item>
            <x-ui.label-selector.item value="engineering">{{ __('Engineering') }}</x-ui.label-selector.item>
            <x-ui.label-selector.item value="product" checked>{{ __('Product') }}</x-ui.label-selector.item>
            <x-ui.label-selector.item value="marketing">{{ __('Marketing') }}</x-ui.label-selector.item>
            <x-ui.label-selector.item value="sales">{{ __('Sales') }}</x-ui.label-selector.item>
        </x-ui.label-selector>
    </div>
</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.0.0. See the site changelog for the full release history.