PF6.Switch

PF6 Switch component

A switch toggles the state of a setting on or off.

Definition

type Switch msg

Opaque Switch type

switch : { onChange : Bool -> msg } -> Switch msg

Construct a Switch

switch { onChange = ToggleFeature }

withLabel : String -> Switch msg -> Switch msg

Set the "on" label (shown when checked)

withLabelOff : String -> Switch msg -> Switch msg

Set a separate "off" label (shown when unchecked)

Set aria-label for accessibility

Set checked state

Disable the switch

Place the label before the toggle (reversed layout)

toMarkup : Switch msg -> Element msg

Render the Switch as an Element msg