LabelledToggle
Component | Source Code
extends ToggleProps, LabelledProps
Props Inheritance Hierarchy: Omit<ComponentPropsWithRef<“span”>, “children” | “onToggle”> -> ToggleProps & LabelledProps
Properties
Section titled “Properties”defaultIsOn?: boolean
Section titled “defaultIsOn?: boolean”disabled?: boolean
Section titled “disabled?: boolean”Whether the toggle is disabled.
error?: string
Section titled “error?: string”info?: string
Section titled “info?: string”isOn?: boolean
Section titled “isOn?: boolean”Whether the toggle is currently on.
label?: string
Section titled “label?: string”labelPosition?: LabelPosition
Section titled “labelPosition?: LabelPosition”What position the label text appears relative to the input.
labelProps?: LabelProps
Section titled “labelProps?: LabelProps”labelTextProps?: InlineTextProps
Section titled “labelTextProps?: InlineTextProps”onToggle?: Function
Section titled “onToggle?: Function”Handler for when the user tries to change whether the toggle is on.