ActionButton ActionButtons allow users to perform an action.
They’re used for similar, task-based options within a workflow, and are ideal for interfaces where buttons aren’t meant to draw a lot of attention.
< ActionButton > Edit< / ActionButton > < ActionButton > Edit< / ActionButton > < ActionButton >
Edit
< / ActionButton >
ActionButtons can have a label, an icon, or both. An icon is provided by passing an icon component as a child to the ActionButton.
A visible label can be provided by passing a string or a Text component as a child, depending on whether the ActionButton has an accompanying icon.
import { Text } from '@react-spectrum/text' ;
import Edit from '@spectrum-icons/workflow/Edit' ;
< ActionButton >
< Edit / >
< Text > Icon + Label< / Text >
< / ActionButton > import { Text } from '@react-spectrum/text' ;
import Edit from '@spectrum-icons/workflow/Edit' ;
< ActionButton >
< Edit / >
< Text > Icon + Label< / Text >
< / ActionButton > import { Text } from '@react-spectrum/text' ;
import Edit from '@spectrum-icons/workflow/Edit' ;
< ActionButton >
< Edit / >
< Text >
Icon + Label
< / Text >
< / ActionButton >
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.
< ActionButton aria-label = "Icon only" >
< Edit / >
< / ActionButton > < ActionButton aria-label = "Icon only" >
< Edit / >
< / ActionButton > < ActionButton aria-label = "Icon only" >
< Edit / >
< / ActionButton >
In order to internationalize an ActionButton, a localized string should be passed to the children or aria-label prop.
ActionButtons support user interactions via mouse, keyboard, and touch. You can handle all of these via the onPress
prop.
The following example uses an onPress handler to update a counter stored in React state.
function Example ( ) {
let [ count, setCount] = React . useState ( 0 ) ;
return (
< ActionButton onPress = { ( ) => setCount ( ( c) => c + 1 ) } >
{ count} Edits
< / ActionButton >
) ;
}
function Example ( ) {
let [ count, setCount] = React . useState ( 0 ) ;
return (
< ActionButton onPress = { ( ) => setCount ( ( c) => c + 1 ) } >
{ count} Edits
< / ActionButton >
) ;
}
function Example ( ) {
let [
count,
setCount
] = React . useState ( 0 ) ;
return (
< ActionButton
onPress = { ( ) =>
setCount (
( c) => c + 1
)
} >
{ count} Edits
< / ActionButton >
) ;
}
Name Type Default Description isQuiet boolean — Whether the button should be displayed with a quiet style . staticColor 'white' | 'black' — The static color style to apply. Useful when the button appears over a color background. type 'button'
| 'submit'
| 'reset' 'button' The behavior of the button when used in an HTML form. 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.
Name Type Default Description 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 Responsive < 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 Responsive < number > — When used in a flex layout, specifies how the element will grow to fit the space available. See MDN . flexShrink Responsive < number > — When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN . flexBasis Responsive < number | string > — When used in a flex layout, specifies the initial main size of the element. See MDN . alignSelf Responsive < '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 Responsive < '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 Responsive < number > — The layout order for the element within a flex or grid container. See MDN . gridArea Responsive < 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 Responsive < string > — When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN . gridRow Responsive < string > — When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN . gridColumnStart Responsive < string > — When used in a grid layout, specifies the starting column to span within the grid. See MDN . gridColumnEnd Responsive < string > — When used in a grid layout, specifies the ending column to span within the grid. See MDN . gridRowStart Responsive < string > — When used in a grid layout, specifies the starting row to span within the grid. See MDN . gridRowEnd Responsive < string > — When used in a grid layout, specifies the ending row to span within the grid. See MDN .
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
< ActionButton isQuiet > Action!< / ActionButton > < ActionButton isQuiet > Action!< / ActionButton > < ActionButton isQuiet >
Action!
< / ActionButton >
View guidelines
< ActionButton isDisabled > Action!< / ActionButton > < ActionButton isDisabled > Action!< / ActionButton > < ActionButton
isDisabled >
Action!
< / ActionButton >