A switch with a label.
Props
Name
Description
Type
Default
activeIcon
Icon to display when switch is on in high contrast mode.
[namespace: stringor
symbol, name: string]or
string
[ICON_NAMESPACE, check]
activeText
Text to display when switch is on in high contrast mode.
string
On
disabled
If the field is disabled.
booleanor
undefined
documentation
Inline documentation text.
stringor
undefined
documentationLink
Inline documentation link.
stringor
undefined
documentationLinkText
Inline documentation link text.
stringor
undefined
inactiveIcon
Icon to display when switch is off in high contrast mode.
[namespace: stringor
symbol, name: string]or
string
[ICON_NAMESPACE, check]
inactiveText
Text to display when switch is off in high contrast mode.
string
Off
invalid
If the field is currently invalid.
booleanor
undefined
label
The label of the field.
string
messages
The messages to display under the field.
ValidationMessagesor
undefined
name
The name of the field.
string
readonly
If the field is editable.
booleanor
undefined
templated
If the field is templated.
no-editor
booleanor
undefined
value
The current value of the field.
boolean
ValidationMessages
Name
Description
Type
Events
Event
Detail
Description
fieldchange
FieldChange<boolean, string>
Emitted when the value of the field is changed.
requestEdit
string
Emitted when the user requests to edit.
Parts
Name
Description
inner
The inner div.