Preview

Accept terms and conditions

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 checkbox

Registry contract

Install confidence

php artisan ui:add checkbox 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.3
License: open
Stability: stable
Contract: v2
Foundation: ≥ 1.0.0

Type	Generated target
blade	resources/views/components/ui/checkbox.blade.php

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Independent selection

Select independent options.

Use when

Use for independent selections that can coexist. Do not use for mutually exclusive choices; radio is clearer.

Avoid when

Avoid using checkbox 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

Radio for mutually exclusive choices

Anti-patterns

Using checkboxes for mutually exclusive answers

API

manifest knowledge + registry-derived coverage

Props

Prop	Type / values	Default	Description
checked	bool	false	Initial checked state.
disabled	bool	false	Disables the native checkbox.
size	string	md	Declared by @props in the registry Blade source.
indeterminate	bool	false	Declared by @props in the registry Blade source.
invalid	bool	false	Declared by @props in the registry Blade source.

Slots

Components use the default Blade slot unless a documented subcomponent is installed by the registry item.

Data slots

checkbox checkbox-field

Capabilities

wcag-2.2-aa-target responsive rtl darkMode localized

Behavior

Uses server-rendered Blade and semantic HTML.
Uses a native checkbox input so form submission and keyboard behavior remain browser-owned.
Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Usage

previews.components.checkbox.default.blade.php Blade

<label class="flex items-center gap-2 text-sm text-foreground">
    <x-ui.checkbox id="preview-checkbox" checked />
    {{ __('Accept terms and conditions') }}
</label>

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

Checkbox