Skip to content
UI Brok

Loading…

No results

Browse catalog

Choicebox

A selectable radio/checkbox option card whose whole surface is a label for a hidden input — rings and reveals a check when selected, with an optional icon and badge. CSS-only.

Preview

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 choicebox

Registry contract

Install confidence

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

Registry dependencies

badge

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 choicebox 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
Related: badge

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
disabled false|true false Documented catalog control used by the preview workbench.
type string radio Declared by @props in the registry Blade source.
name mixed|null null Declared by @props in the registry Blade source.
value 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.
checked bool false Declared by @props in the registry Blade source.
badge mixed|null null Declared by @props in the registry Blade source.

Slots

  • default — Primary Blade slot rendered by the component.

Data slots

choicebox

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.choicebox.default.blade.php Blade
<div class="grid w-full max-w-md gap-3">
    <x-ui.choicebox
        name="plan"
        value="pro"
        :title="__('Pro')"
        :description="__('Everything in Starter plus advanced analytics and priority support.')"
        badge="Popular"
        :checked="true"
    />
    <x-ui.choicebox
        name="plan"
        value="starter"
        :title="__('Starter')"
        :description="__('For individuals getting started — up to 3 projects.')"
    />
    <x-ui.choicebox
        name="plan"
        value="enterprise"
        :title="__('Enterprise')"
        :description="__('Custom limits, SSO and a dedicated account manager.')"
        :disabled="true"
    />
</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.1. See the site changelog for the full release history.