Docs
Components
Dark
Light
System
A toggle control for switching between two states.
Use the size prop to change the size of the switch
size
Use the color and unCheckColor prop to change the color of the switch
color
unCheckColor
Use the onToggleSwitch prop to get the switch state
onToggleSwitch
With the on prop you can set the switch default state
on
Type:
"sm" | "md" | "lg" | "xl"
Defines the size of the switch.
Default:
boolean
Controls the switch default state.
function
Callback function that gets triggered when the switch state changes. Receives the new state as an argument.
ColorPair
Specifies the color of the switch when it is turned off.
Defines the color of the switch when it is turned on.
disabled
Disables interaction with the switch when set to true.
className
string
Allows custom styling by applying additional CSS classes.
