Guides
Navigation
Feedback
Overlays
Layout
Data Display
Forms
.md

Forms

toggle

Two-state button built on a native checkbox, submits with the form.

Installation

php artisan ui:add toggle

Usage

<x-ui.toggle name="bold" :pressed="true" aria-label="Bold">B</x-ui.toggle>
<x-ui.toggle variant="outline" name="italic">Italic</x-ui.toggle>

{{-- size: sm, md (default) or lg. value is submitted when pressed. --}}
<x-ui.toggle name="mode" value="grid" size="sm">Grid</x-ui.toggle>
<x-ui.toggle name="mode" value="list" size="lg">List</x-ui.toggle>

Pure CSS over a native checkbox, no JavaScript. Variants: default, outline. Sizes: sm, md, lg. Pass `name` to submit its state and `pressed` to start on.

Props

Every prop with its default. Pass any of them as attributes, using : to bind a PHP value.

@props([
    'variant' => 'default',
    'size' => 'md',
    'name' => null,
    'value' => '1',
    'pressed' => false,
])