active
Type
booleanSwitch
Switch is a component used to toggle between on and off states.
Props
SwitchIconProps
checked
Type
booleanfocused
Type
booleanhovered
Type
booleanisActive
DeprecatedDeprecated
Use active instead.
Type
booleanisChecked
DeprecatedDeprecated
Use checked instead.
Type
booleanisFocused
DeprecatedDeprecated
Use focused instead.
Type
booleanisHovered
DeprecatedDeprecated
Use hovered instead.
Type
booleanSwitchProps
checked
Description
If true, the checkbox will be checked.
Type
booleanDefault
falsecolorScheme
Description
The visual color appearance of the component.
Type
"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"Default
"primary"defaultChecked
Description
If true, the checkbox will be initially checked.
Type
booleanDefault
falsedefaultIsChecked
DeprecatedDescription
If true, the checkbox will be initially checked.
Deprecated
Use defaultChecked instead.
Type
booleanDefault
falsedisabled
Description
If true, the form control will be disabled.
Type
booleanDefault
falseicon
Description
The switch icon to use.
Type
ReactElement<SwitchIconProps,
string | JSXElementConstructor<any>>id
Description
id assigned to input.
Type
stringindeterminate
Description
If true, the checkbox will be indeterminate.
Type
booleanDefault
falseinputProps
Description
Props for switch input element.
Type
InputHTMLAttributes<HTMLInputElement>invalid
Description
If true, the form control will be invalid.
Type
booleanDefault
falseisChecked
DeprecatedDescription
If true, the checkbox will be checked.
Deprecated
Use checked instead.
Type
booleanDefault
falseisDisabled
DeprecatedDescription
If true, the form control will be disabled.
Deprecated
Use disabled instead.
Type
booleanDefault
falseisInvalid
DeprecatedDescription
If true, the form control will be invalid.
Deprecated
Use invalid instead.
Type
booleanDefault
falseisReadOnly
DeprecatedDescription
If true, the form control will be readonly.
Deprecated
Use readOnly instead.
Type
booleanDefault
falseisRequired
DeprecatedDescription
If true, the form control will be required.
Deprecated
Use required instead.
Type
booleanDefault
falseisReverse
DeprecatedDescription
Change switch label from right to left.
Deprecated
Use reverse instead.
Type
booleanDefault
falselabelProps
Description
Props for switch label element.
Type
HTMLUIProps<"span">name
Description
The HTML name attribute used for forms.
Type
stringonBlur
Description
The callback invoked when the checkbox is blurred.
Type
FocusEventHandler<HTMLInputElement>onChange
Description
The callback invoked when the checked state changes.
Type
ChangeEventHandler<HTMLInputElement>onFocus
Description
The callback invoked when the checkbox is focused.
Type
FocusEventHandler<HTMLInputElement>readOnly
Description
If true, the form control will be readonly.
Type
booleanDefault
falserequired
Description
If true, the form control will be required.
Type
booleanDefault
falsereverse
Description
Change switch label from right to left.
Type
booleanDefault
falseselectOnEnter
Description
If true, the checkbox will be selected when the Enter key is pressed.
Type
booleanDefault
falsesize
Description
The size of the Switch.
Type
"sm" | "md" | "lg"Default
"md"tabIndex
Description
The tab-index property of the underlying input element.
Type
numbertransition
Description
Motion transition settings.
Type
Transition$1value
Description
The value to be used in the checkbox input.
Type
stringvariant
Description
The variant of the Switch.
Type
"thin" | "thick"Default
"thick"Edit this page on GitHub