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 toggle-group

Behavior layer (Alpine)

This component installs a self-registering Alpine module to resources/js/ui/toggle-group.js. Import the behavior layer once from your bundle so it loads (it hooks alpine:init):

resources/js/ui/index.js JS

import './toggle-group.js';

Registry contract

Install confidence

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

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

npm: alpinejs

Guidance

Bounded compact selection

Choose from a bounded option set in limited space.

Use when

Use when users choose among a bounded set and space efficiency matters more than always-visible comparison. Do not use for tiny lists or when users benefit from seeing all options at once.

Avoid when

Avoid using toggle-group 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: No

Preferred alternatives

Radio or checkbox for visible comparison

Anti-patterns

Hiding tiny or high-frequency option sets

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
type	string	single	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.

Slots

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

Data slots

toggle-group toggle-group-item

Capabilities

wcag-2.2-aa-target interactive responsive rtl darkMode localized

Behavior

Uses server-rendered Blade and semantic HTML.
Installs a JavaScript behavior module when the registry item includes resources/js/ui files.
Declares registry capability flags: a11y, interactive, responsive, rtl, darkMode, localized.

Usage

previews.components.toggle-group.default.blade.php Blade

<div class="flex flex-col gap-6">
    <x-ui.toggle-group type="single" name="align" value="center" aria-label="{{ __('Text alignment') }}">
        <x-ui.toggle-group.item value="left">{{ __('Left') }}</x-ui.toggle-group.item>
        <x-ui.toggle-group.item value="center">{{ __('Center') }}</x-ui.toggle-group.item>
        <x-ui.toggle-group.item value="right">{{ __('Right') }}</x-ui.toggle-group.item>
    </x-ui.toggle-group>

    <x-ui.toggle-group type="multiple" name="format" aria-label="{{ __('Text formatting') }}">
        <x-ui.toggle-group.item value="bold"><strong>{{ __('Bold') }}</strong></x-ui.toggle-group.item>
        <x-ui.toggle-group.item value="italic"><em>{{ __('Italic') }}</em></x-ui.toggle-group.item>
        <x-ui.toggle-group.item value="underline"><span class="underline">{{ __('Underline') }}</span></x-ui.toggle-group.item>
    </x-ui.toggle-group>
</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.

Toggle Group