Skip to main content

Switch

Ant Design

The Switch component is Ant Design's on and off toggle. It turns a single setting on or off, such as email alerts or a feature flag, with its label beside it.

Properties​

Property
Description
Expected Value
LabelText shown beside the switch, or above it when Layout is vertical.Text. Default: Enabled
ExtraHelp text shown under the field. A validation message replaces it while the value is not valid.Text
TooltipText shown from an info icon after the label.Text
LayoutWhere the label sits: horizontal puts it to the left of the switch, vertical puts it above.vertical, horizontal. Default: horizontal
CheckedWhether the switch starts on.On or off. Default: Off
Checked textShort text shown inside the switch while it's on, such as On.Text
Unchecked textShort text shown inside the switch while it's off, such as Off.Text
SizeSize of the switch.default, small. Default: default

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On changeTriggers when the switch turns on or off.
On clickTriggers when the user clicks the switch.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set checkedTurns the switch on or off to match Checked.components.switch1.setFieldValue("")
Reset fieldSets the switch back to the Checked property.components.switch1.resetFields()
ToggleFlips the switch to the opposite state.components.switch1.toggle()
Set visibilityShows the component when true, hides it when false.components.switch1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.switch1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.switch1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown beside the switch, or above it when Layout is vertical.{{components.switch1.label}}
extraHelp text shown under the field. A validation message replaces it while the value is not valid.{{components.switch1.extra}}
tooltipText shown from an info icon after the label.{{components.switch1.tooltip}}
layoutWhere the label sits: horizontal puts it to the left of the switch, vertical puts it above.{{components.switch1.layout}}
checkedWhether the switch starts on.{{components.switch1.checked}}
checkedChildrenShort text shown inside the switch while it's on, such as On.{{components.switch1.checkedChildren}}
unCheckedChildrenShort text shown inside the switch while it's off, such as Off.{{components.switch1.unCheckedChildren}}
sizeSize of the switch.{{components.switch1.size}}
valuetrue while the switch is on, the same as Checked. A Form reads this key.{{components.switch1.value}}
isVisibleWhether the component is visible.{{components.switch1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.switch1.isLoading}}
isDisabledWhether the component is disabled.{{components.switch1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.