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

Registry contract

Install confidence

php artisan ui:add button-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/button-group.blade.php
blade	resources/views/components/ui/button-group/text.blade.php
blade	resources/views/components/ui/button-group/separator.blade.php

Registry dependencies

separator

Package dependencies

composer: jml/brok:^1.0

Guidance

Buttons and direct actions

Commit an explicit user action.

Use when

Use for explicit actions and commits; keep one action visually primary when several sit together. Do not use button treatment for navigation-only view changes when links, tabs, or radios describe state more clearly.

Avoid when

Avoid using button-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: precise
Mobile / touch risk: low
Accessibility risk: medium
Needs background context: No
Comparison needed: No

Preferred alternatives

Link for navigation
Tabs or radios for view changes

Anti-patterns

Using a button for navigation-only state changes
Presenting multiple equally dominant primary actions

Related: separator

API

manifest knowledge + registry-derived coverage

Props

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

Slots

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

Data slots

button-group button-group-separator button-group-text

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.button-group.default.blade.php Blade

<x-ui.button-group>
    <x-ui.button variant="outline">{{ __('Years') }}</x-ui.button>
    <x-ui.button variant="outline">{{ __('Months') }}</x-ui.button>
    <x-ui.button variant="outline">{{ __('Days') }}</x-ui.button>
</x-ui.button-group>

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.

Button Group