Phenix Storybook

Toggle Switch

You can turn me on or off

Attribute Type Documentation Default Value
id :string

The component ID
Required form * :any

The form around the input group.
field :atom

The form field key.
name :string

The form field name.
label :string

The input label
toggle_label :string

Inline toggle label
toggle_label_on :string

Inline toggle label, only displayed when value is true
toggle_label_off :string

Inline toggle label, only displayed when value is false
style :atom

The toggle switch style
:default
hint :string

An hint to display below the input
disabled :boolean

Set to true to disable the input.
false
value :any

The toggle state (boolean or string)
group_class :string

Extend input group class
hint_class :string

Extend input hint class