Skip to content
This repository has been archived by the owner on Dec 29, 2021. It is now read-only.

Form ToggleField

Luca Longo edited this page Aug 31, 2020 · 2 revisions

Render a toggle field that allows binary values (true/false). It's like a checkbox, but empowered!

Properties

name type default value description
id ?string null Field ID (autogenerated if empty)
name ?string null Field name
label ?string null Label visible on the form
errorBag ?string null Error field returned from the bag
disabled bool false Determs if the field is disable (or not)
readOnly bool false Determs if the field is read-only (or not)
value mixed null Field value
hint ?string null Hint text shown above the form component
help ?string null Hint text shown after the form component
trueValue mixed true Value that match the true condition
falseValue mixed false Value that match the false condition

Usage

<x-bc-form:toggle-field label="Toggle field" error-bag="toggleField" :value-format="true" @input="console.log('Value changed')" />

or, if you use Laravel Livewire:

<x-bc-form:toggle-field label="Toggle field" error-bag="toggleField" :value-format="true" wire:model="toggleField" />

You can also customize the values:

<x-bc-form:toggle-field label="Toggle field" error-bag="toggleField" :value-format="yes" wire:model="toggleField" true-value="yes" false-value="no"  />

Scopes

  • prepend
  • append

Example:

<x-bc-form:toggle-field>
    <x-slot name="prepend">Prepend</x-slot>
    <x-slot name="append">Append</x-slot>
</x-bc-form:toggle-field>