Offer a similar experience as a checkbox or radio with the appearance of a button.
A ToggleButton uses the following components:
A toggle button can use different variants.
A toggle button can vary in size.
A toggle button can be disabled.
A toggle button can show a loading indicator. The button text is hidden but the button maintains the width that it would have if the text were visible.
Toggle buttons can indicate that a quick progress task is taking place (e.g., saving settings on a server). After a 1 second delay, an indeterminate spinner will be displayed in place of the button label and icon.
A toggle button can be expanded to full width to fill its parent container.
A toggle button can contain only an icon. An accessible name must be provided through aria-label prop. See also WCAG practices.
A toggle button can contain icons.
Nonstandard end icons can be provided to handle special cases. However, think twice before adding end icons, start icons should be your go-to.
The content to display in the button.
Whether or not the toggle button takes up the width of its container.
A toggle button can show a loading indicator.
A toggle button can vary in size.
The props for the Spinner.
The visual style of the toggle button.
The id of the toggle button.
The inline style for the element. A function may be provided to compute the style based on component state.
The behavior of the button when used in an HTML form.
Whether the element should be selected (controlled).
Whether the element should be selected (uncontrolled).
Whether the button is disabled.
Whether the element should receive focus on render.
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 element's selection state changes.
Handler that is called when the press is released over the target.
Handler that is called when a press interaction starts.
Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.
Handler that is called when the press state changes.
Handler that is called when a press is released over the target, regardless of whether it started on the target or not.
Not recommended – use onPress instead. onClick is an alias for onPress
provided for compatibility with other libraries. onPress provides
additional event details for non-mouse interactions.
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.
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Identifies the element (or elements) whose contents or presence are controlled by the current element.
Indicates the current "pressed" state of toggle buttons.
Whether to prevent focus from moving to the button when pressing it.
Caution, this can make the button inaccessible and should only be used when alternative keyboard interaction is provided, such as ComboBox's MenuTrigger or a NumberField's increment/decrement control.
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.
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:
fluid has been renamed isFluid.disabled has been renamed isDisabled.checked has been renamed isSelected.defaultChecked has been renamed defaultSelected.inherit has been removed.loading has been renamed isLoading.onChange signature has been changed (no event is passed).value has been removed, use the id instead.