Skip to content
UI Brok

Loading…

No results

Browse catalog

Switch

Toggle switch with RTL-aware thumb movement — sm/md/lg sizes, pill or rounded radius and an optional inline label.

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 switch

Registry contract

Install confidence

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

Registry dependencies

None.

Package dependencies

composer: jml/brok:^1.0

Guidance

Immediate reversible state

Change an immediate reversible system state.

Use when

  • Use for immediate state changes that are obvious and reversible. Do not use for choices that need explanation, confirmation, or a later Save step.

Avoid when

  • Only use when the user expects an immediate, obvious, and reversible state change.
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

  • Checkbox for a value saved later
  • Button plus confirmation for consequential actions

Anti-patterns

  • Using a switch when Save is required
  • Using a switch for irreversible actions

API

manifest knowledge + registry-derived coverage

Props

Prop Type / values Default Description
checked bool false Initial on/off state.
disabled bool false Disables interaction.
size string md Declared by @props in the registry Blade source.
radius string pill Declared by @props in the registry Blade source.
label mixed|null null Declared by @props in the registry Blade source.
invalid bool false Declared by @props in the registry Blade source.

Slots

  • default — Primary Blade slot rendered by the component.

Data slots

switch

Capabilities

wcag-2.2-aa-target responsive rtl darkMode localized

Behavior

  • Uses server-rendered Blade and semantic HTML.
  • Mirrors state into an accessible switch-style control and forwards name/value attributes for forms.
  • Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Usage

previews.components.switch.default.blade.php Blade 
<div class="flex flex-col gap-5">
    <x-ui.switch checked>{{ __('Enable notifications') }}</x-ui.switch>

    <div class="flex items-center gap-5">
        <x-ui.switch size="sm" checked aria-label="{{ __('Small') }}" />
        <x-ui.switch size="md" checked aria-label="{{ __('Medium') }}" />
        <x-ui.switch size="lg" checked aria-label="{{ __('Large') }}" />
        <x-ui.switch radius="rounded" checked aria-label="{{ __('Rounded') }}" />
    </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.1.2. See the site changelog for the full release history.