ToggleButton ToggleButtons allow users to toggle a selection on or off, for example
switching between two states or modes.
< ToggleButton > Pin< / ToggleButton > < ToggleButton > Pin< / ToggleButton > < ToggleButton >
Pin
< / ToggleButton >
ToggleButtons can have a label, an icon, or both. An icon is provided by passing an icon component as a child to the ToggleButton.
A visible label can be provided by passing a string or a Text component as a child, depending on whether the ToggleButton has an accompanying icon.
import { Text } from '@react-spectrum/text' ;
import Pin from '@spectrum-icons/workflow/PinOff' ;
< ToggleButton >
< Pin / >
< Text > Icon + Label< / Text >
< / ToggleButton > import { Text } from '@react-spectrum/text' ;
import Pin from '@spectrum-icons/workflow/PinOff' ;
< ToggleButton >
< Pin / >
< Text > Icon + Label< / Text >
< / ToggleButton > import { Text } from '@react-spectrum/text' ;
import Pin from '@spectrum-icons/workflow/PinOff' ;
< ToggleButton >
< Pin / >
< Text >
Icon + Label
< / Text >
< / ToggleButton >
If no visible label is provided (e.g. an icon only button),
an alternative text label must be provided to identify the control for accessibility. This should be added using
the aria-label prop.
< ToggleButton aria-label = "Icon only" >
< Pin / >
< / ToggleButton > < ToggleButton aria-label = "Icon only" >
< Pin / >
< / ToggleButton > < ToggleButton aria-label = "Icon only" >
< Pin / >
< / ToggleButton >
Note: ToggleButton should not be used when the content of the button changes between selection states, for example,
mute/unmute or play/pause. In these cases, use an ActionButton instead.
In order to internationalize an ToggleButton, a localized string should be passed to the children or aria-label prop.
ToggleButtons are not selected by default. The defaultSelected prop can be used to set the default state (uncontrolled).
Alternatively, the isSelected prop can be used to make the selected state controlled. See React's documentation on
uncontrolled components for more info, and Events , below,
for an example of controlled behavior.
ToggleButtons support user interactions via mouse, keyboard, and touch. When pressing the button, the selection
state is toggled, and the onChange event is fired. The following example uses an onChange handler to update React state.
function Example ( ) {
let [ isSelected, setSelected] = React . useState ( false ) ;
return (
< ToggleButton
isEmphasized
isSelected = { isSelected}
onChange = { setSelected}
aria-label = "Pin" >
< Pin / >
< / ToggleButton >
) ;
}
function Example ( ) {
let [ isSelected, setSelected] = React . useState ( false ) ;
return (
< ToggleButton
isEmphasized
isSelected = { isSelected}
onChange = { setSelected}
aria-label = "Pin" >
< Pin / >
< / ToggleButton >
) ;
}
function Example ( ) {
let [
isSelected,
setSelected
] = React . useState (
false
) ;
return (
< ToggleButton
isEmphasized
isSelected = {
isSelected
}
onChange = {
setSelected
}
aria-label = "Pin" >
< Pin / >
< / ToggleButton >
) ;
}
Name Type Default Description isEmphasized boolean — Whether the button should be displayed with an emphasized style . isSelected boolean — Whether the element should be selected (controlled). defaultSelected boolean — Whether the element should be selected (uncontrolled). isDisabled boolean — Whether the button is disabled. children ReactNode — The content to display in the button. autoFocus boolean — Whether the element should receive focus on render. isQuiet boolean — Whether the button should be displayed with a quiet style . type 'button'
| 'submit'
| 'reset' 'button' The behavior of the button when used in an HTML form.
Name Type Default Description onChange (
( isSelected : boolean
) ) => void — Handler that is called when the element's selection state changes. onPress (
( e : PressEvent
) ) => void — Handler that is called when the press is released over the target. onPressStart (
( e : PressEvent
) ) => void — Handler that is called when a press interaction starts. onPressEnd (
( e : PressEvent
) ) => void — Handler that is called when a press interaction ends, either
over the target or when the pointer leaves the target. onPressChange (
( isPressed : boolean
) ) => void — Handler that is called when the press state changes. onPressUp (
( e : PressEvent
) ) => void — Handler that is called when a press is released over the target, regardless of
whether it started on the target or not. onFocus (
( e : FocusEvent
) ) => void — Handler that is called when the element receives focus. onBlur (
( e : FocusEvent
) ) => void — Handler that is called when the element loses focus. onFocusChange (
( isFocused : boolean
) ) => void — Handler that is called when the element's focus status changes. onKeyDown (
( e : KeyboardEvent
) ) => void — Handler that is called when a key is pressed. onKeyUp (
( e : KeyboardEvent
) ) => void — Handler that is called when a key is released.
Name Type Default Description flex string
| number
| boolean — When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN . flexGrow number — When used in a flex layout, specifies how the element will grow to fit the space available. See MDN . flexShrink number — When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN . flexBasis number | string — When used in a flex layout, specifies the initial main size of the element. See MDN . alignSelf 'auto'
| 'normal'
| 'start'
| 'end'
| 'center'
| 'flex-start'
| 'flex-end'
| 'self-start'
| 'self-end'
| 'stretch' — Overrides the alignItems property of a flex or grid container. See MDN . justifySelf 'auto'
| 'normal'
| 'start'
| 'end'
| 'flex-start'
| 'flex-end'
| 'self-start'
| 'self-end'
| 'center'
| 'left'
| 'right'
| 'stretch' — Specifies how the element is justified inside a flex or grid container. See MDN . order number — The layout order for the element within a flex or grid container. See MDN . gridArea string — When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN . gridColumn string — When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN . gridRow string — When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN . gridColumnStart string — When used in a grid layout, specifies the starting column to span within the grid. See MDN . gridColumnEnd string — When used in a grid layout, specifies the ending column to span within the grid. See MDN . gridRowStart string — When used in a grid layout, specifies the starting row to span within the grid. See MDN . gridRowEnd string — When used in a grid layout, specifies the ending row to span within the grid. See MDN .
Name Type Default Description margin DimensionValue — The margin for all four sides of the element. See MDN . marginTop DimensionValue — The margin for the top side of the element. See MDN . marginBottom DimensionValue — The margin for the bottom side of the element. See MDN . marginStart DimensionValue — The margin for the logical start side of the element, depending on layout direction. See MDN . marginEnd DimensionValue — The margin for the logical end side of an element, depending on layout direction. See MDN . marginX DimensionValue — The margin for both the left and right sides of the element. See MDN . marginY DimensionValue — The margin for both the top and bottom sides of the element. See MDN .
Name Type Default Description position 'static'
| 'relative'
| 'absolute'
| 'fixed'
| 'sticky' — Specifies how the element is positioned. See MDN . top DimensionValue — The top position for the element. See MDN . bottom DimensionValue — The bottom position for the element. See MDN . left DimensionValue — The left position for the element. See MDN . Consider using start instead for RTL support. right DimensionValue — The right position for the element. See MDN . Consider using start instead for RTL support. start DimensionValue — The logical start position for the element, depending on layout direction. See MDN . end DimensionValue — The logical end position for the element, depending on layout direction. See MDN . zIndex number — The stacking order for the element. See MDN . isHidden boolean — Hides the element.
Name Type Default Description id string — The element's unique identifier. See MDN . excludeFromTabOrder boolean — 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. aria-expanded boolean — Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. aria-haspopup boolean
| 'menu'
| 'listbox'
| 'tree'
| 'grid'
| 'dialog' — Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. aria-controls string — Identifies the element (or elements) whose contents or presence are controlled by the current element. aria-pressed boolean — Indicates the current "pressed" state of toggle buttons. aria-label string — Defines a string value that labels the current element. aria-labelledby string — Identifies the element (or elements) that labels the current element. aria-describedby string — Identifies the element (or elements) that describes the object. aria-details string — Identifies the element (or elements) that provide a detailed, extended description for the object.
Name Type Default Description UNSAFE_className string — Sets the CSS className for the element. Only use as a last resort . Use style props instead. UNSAFE_style CSSProperties — Sets inline style for the element. Only use as a last resort . Use style props instead.
View guidelines
< ToggleButton isQuiet > Pin< / ToggleButton > < ToggleButton isQuiet > Pin< / ToggleButton > < ToggleButton isQuiet >
Pin
< / ToggleButton >
View guidelines
< ToggleButton isDisabled > Pin< / ToggleButton > < ToggleButton isDisabled > Pin< / ToggleButton > < ToggleButton
isDisabled >
Pin
< / ToggleButton >
View guidelines
< ToggleButton isEmphasized defaultSelected >
Pin
< / ToggleButton > < ToggleButton isEmphasized defaultSelected >
Pin
< / ToggleButton > < ToggleButton
isEmphasized
defaultSelected >
Pin
< / ToggleButton >