A switch is used to quickly switch between two possible states.
Switch is a control that is used to quickly switch between two possible states. Switches are only used for these binary actions that occur immediately after the user “flips the switch.” They are commonly used for “on/off” switches.
<Switch> <IconList /> /* (Optional) A list of icons in the switch */ <Icon /> /* (Optional) An icon in the switch */ <Text /> /* (Optional) Text in the switch */ </Switch>
A Switch uses the following components:
A switch can be selected.
A switch can be rendered without a label.
A switch can be disabled.
A switch field can be disabled.
A switch can vary in size.
A switch field can vary in size.
A switch can be rendered with an icon or an icon list.
Switches should:
Checkbox and Switch components are very similar in term of results when used in a form. However, a few details tell them apart.
A Switch can vary in size.
The element to associate the input with. The value of this attribute must be the id of a in the same document.
See MDN.
The inline style for the element. A function may be provided to compute the style based on component state.
The children of the component. A function may be provided to alter the children based on component state.
Whether the Switch should be selected (uncontrolled).
Whether the Switch should be selected (controlled).
The value of the input element, used when submitting an HTML form. See MDN.
Whether the input is disabled.
Whether the input can be selected but not changed by the user.
Whether the element should receive focus on render.
The name of the input element, used when submitting an HTML form. See MDN.
A ref for the HTML input element.
The CSS className for the element. A function may be provided to compute the class based on component state.
Handler that is called when the Switch's selection state changes.
Handler that is called when the element receives focus.
Handler that is called when the element loses focus.
Handler that is called when the element's focus status changes.
Handler that is called when a key is pressed.
Handler that is called when a key is released.
Handler that is called when a hover interaction starts.
Handler that is called when a hover interaction ends.
Handler that is called when the hover state changes.
A slot name for the component. Slots allow the component to receive props from a parent component.
An explicit null value indicates that the local props completely override all props received from a parent.
Identifies the element (or elements) whose contents or presence are controlled by the current element.
Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.
The element's unique identifier. See MDN.
Defines a string value that labels the current element.
Identifies the element (or elements) that labels the current element.
Identifies the element (or elements) that describes the object.
Identifies the element (or elements) that provide a detailed, extended description for the object.
The description of the switch field.
Whether the switch field is disabled.
A switch field can vary in size.
The children of the component. A function may be provided to alter the children based on component state.
The CSS className for the element. A function may be provided to compute the class based on component state.
The inline style for the element. A function may be provided to compute the style based on component state.
A slot name for the component. Slots allow the component to receive props from a parent component.
An explicit null value indicates that the local props completely override all props received from a parent.
Defines a string value that labels the current element.
Identifies the element (or elements) that labels the current element.
Identifies the element (or elements) that describes the object.
Identifies the element (or elements) that provide a detailed, extended description for the object.
Coming from Orbiter, you should be aware of the following changes:
onChange signature has been changed – no events are passed.onValueChange has been deleted, use onChange instead.checked has been renamed to isSelected.disabled has been renamed to isDisabled.Counter component is no longer allowed as a specialized slot.reverse is not supported, use flex-direction or row-reverse instead.validationState has been removed. A Switch cannot be invalid.