ActionButton ActionButtons allow users to perform an action or mark a selection.
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.
import { Text } from '@react-spectrum/typography' ;
< ActionButton >
< Edit / >
< Text > Edit< / Text >
< / 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.
< ActionButton >
Label only
< / ActionButton >
< ActionButton >
< Edit / >
< Text > Icon + Label< / Text >
< / ActionButton >
< ActionButton aria-label = "Icon only" >
< Edit / >
< / 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.
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 >
) ;
}
Name Type Default Description isQuiet boolean — Whether the ActionButton should be displayed with a quiet style . isSelected boolean — Whether the ActionButton should be displayed with a selected state . isEmphasized boolean — Whether the ActionButton should be displayed with a emphasized style . holdAffordance boolean — Whether the ActionButton should be displayed with a hold icon . isDisabled boolean — Whether the button is disabled elementType string | JSXElementConstructor < any > "button" The HTML element or React element used to render the button, e.g. "div", "a", or RouterLink. children ReactNode — The content to display in the button. href string — A URL to link to if elementType="a". target string — The target window for the link. 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 interation 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 role string — id string — tabIndex number — 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-controls string — Identifies the element (or elements) whose contents or presence are controlled by the current element. aria-owns string — Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
between DOM elements where the DOM hierarchy cannot be used to represent the relationship. aria-hidden boolean | 'false' | 'true' — Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
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 >
View guidelines
< ActionButton isSelected > Action!< / ActionButton >
View guidelines
Note that the styling provided by the isEmphasized prop is only applied when the isSelected prop is true.
< ActionButton isEmphasized isSelected > Action!< / ActionButton >
View guidelines
< ActionButton holdAffordance aria-label = "Edit" >
< Edit / >
< / ActionButton >
View guidelines
< ActionButton isDisabled > Action!< / ActionButton >
Name Type Description type 'pressstart'
| 'pressend'
| 'pressup'
| 'press' The type of press event being fired. pointerType PointerType The pointer type that triggered the press event. target HTMLElement The target element of the press event. shiftKey boolean Whether the shift keyboard modifier was held during the press event. ctrlKey boolean Whether the ctrl keyboard modifier was held during the press event. metaKey boolean Whether the meta keyboard modifier was held during the press event.
'mouse'
| 'pen'
| 'touch'
| 'keyboard'
| 'virtual' T & { stopPropagation : ( ) => void ,
continuePropagation : ( ) => void
} See the Styling docs for a visualization of these values.
'size-0'
| 'size-10'
| 'size-25'
| 'size-40'
| 'size-50'
| 'size-65'
| 'size-75'
| 'size-85'
| 'size-100'
| 'size-115'
| 'size-125'
| 'size-130'
| 'size-150'
| 'size-160'
| 'size-175'
| 'size-200'
| 'size-225'
| 'size-250'
| 'size-300'
| 'size-350'
| 'size-400'
| 'size-450'
| 'size-500'
| 'size-550'
| 'size-600'
| 'size-675'
| 'size-700'
| 'size-800'
| 'size-900'
| 'size-1000'
| 'size-1200'
| 'size-1250'
| 'size-1600'
| 'size-1700'
| 'size-2000'
| 'size-2400'
| 'size-3000'
| 'size-3400'
| 'size-3600'
| 'size-4600'
| 'size-5000'
| 'size-6000'
| 'static-size-0'
| 'static-size-10'
| 'static-size-25'
| 'static-size-50'
| 'static-size-40'
| 'static-size-65'
| 'static-size-100'
| 'static-size-115'
| 'static-size-125'
| 'static-size-150'
| 'static-size-175'
| 'static-size-200'
| 'static-size-225'
| 'static-size-250'
| 'static-size-300'
| 'static-size-400'
| 'static-size-450'
| 'static-size-500'
| 'static-size-550'
| 'static-size-600'
| 'static-size-700'
| 'static-size-800'
| 'static-size-900'
| 'static-size-1000'
| 'static-size-1200'
| 'static-size-1700'
| 'static-size-2400'
| 'static-size-2600'
| 'static-size-3400'
| 'static-size-3600'
| 'static-size-4600'
| 'static-size-5000'
| 'static-size-6000'
| 'single-line-height'
| 'single-line-width'
| string & { }
| number