English (United Kingdom)

Displays a toggle button.

type

(string)  Must be equals to checkbox.

label

(string)  The label to display next to the field.

help

(string)  An optional text to describe the purpose of the field.

required

(bool)  Whether the field is mandatory or optional.

checked

(bool)  Whether the field should be checked or not.

value

(string)  The checkbox attribute value ("1" by default).

id

(string)  An optional field ID.

class

(string)  An optional field class suffix.

 

disabled

(bool)  Whether the field should be disabled or not.

onchange

(string)  Defines the onchange attribute with the provided callback.

hidden

(bool)  True to avoid displaying the label of the field.

[
    'toggle' => [
        'type' => 'checkbox',
        'label' => 'Toggle',
        'checked' => true,
    ]
]

Changelog

Version Description
1.3 Introduced.
Last Update: 2024-01-04
Helpful?