Button Buttons allow users to perform an action or to navigate to another page.
They have multiple styles for various needs, and are ideal for calling attention to
where a user needs to do something in order to move forward in a flow.
< Button variant = "cta" > Save< / Button >
< Button variant = "cta" > Save< / Button >
< Button variant = "cta" >
Save
< / Button >
Buttons can have a label, and icon, or both. An icon is provided by passing an icon component to the icon
prop.
A visible label can be provided by passing children.
import { Text } from '@react-spectrum/typography' ;
< Button variant = "primary" > Label only< / Button >
< Button variant = "primary" >
< Bell / >
< Text > Icon + Label< / Text >
< / Button >
< Button variant = "primary" aria-label = "Icon only" >
< Bell / >
< / Button >
import { Text } from '@react-spectrum/typography' ;
< Button variant = "primary" > Label only< / Button >
< Button variant = "primary" >
< Bell / >
< Text > Icon + Label< / Text >
< / Button >
< Button variant = "primary" aria-label = "Icon only" >
< Bell / >
< / Button >
import { Text } from '@react-spectrum/typography' ;
< Button variant = "primary" >
Label only
< / Button >
< Button variant = "primary" >
< Bell / >
< Text >
Icon + Label
< / Text >
< / Button >
< Button
variant = "primary"
aria-label = "Icon only" >
< Bell / >
< / Button >
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 a button, a localized string should be passed to the children
or aria-label
prop.
Buttons 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 (
< Button variant = "primary" onPress = { ( ) => setCount ( ( c) => c + 1 ) } >
{ count} Dogs
< / Button >
) ;
}
function Example ( ) {
let [ count, setCount] = React . useState ( 0 ) ;
return (
< Button
variant = "primary"
onPress = { ( ) => setCount ( ( c) => c + 1 ) } >
{ count} Dogs
< / Button >
) ;
}
function Example ( ) {
let [
count,
setCount
] = React . useState ( 0 ) ;
return (
< Button
variant = "primary"
onPress = { ( ) =>
setCount (
( c) => c + 1
)
} >
{ count} Dogs
< / Button >
) ;
}
Name Type Default Description variant
'cta'
| 'overBackground'
| 'primary'
| 'secondary'
| 'negative'
— The visual style of the button. 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. 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 UNSAFE_className
string
— UNSAFE_style
CSSProperties
—
EventsName 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.
LayoutName Type Default Description flex
string | number | boolean
— flexGrow
number
— flexShrink
number
— flexBasis
number | string
— alignSelf
'auto'
| 'normal'
| 'start'
| 'end'
| 'flex-start'
| 'flex-end'
| 'self-start'
| 'self-end'
| 'center'
| 'stretch'
— justifySelf
'auto'
| 'normal'
| 'start'
| 'end'
| 'flex-start'
| 'flex-end'
| 'self-start'
| 'self-end'
| 'center'
| 'left'
| 'right'
| 'stretch'
— flexOrder
number
— gridArea
string
— gridColumn
string
— gridRow
string
— gridColumnStart
string
— gridColumnEnd
string
— gridRowStart
string
— gridRowEnd
string
—
Spacing Sizing Positioning AccessibilityName Type Default Description id
string
— tabIndex
number
— 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.
View guidelines
< Button variant = "cta" > Save< / Button >
< Button variant = "cta" > Save< / Button >
< Button variant = "cta" >
Save
< / Button >
View guidelines
< Button variant = "primary" > Save< / Button >
< Button variant = "primary" isQuiet > Save< / Button >
< Button variant = "primary" > Save< / Button >
< Button variant = "primary" isQuiet > Save< / Button >
< Button variant = "primary" >
Save
< / Button >
< Button
variant = "primary"
isQuiet >
Save
< / Button >
View guidelines
< Button variant = "secondary" > Save< / Button >
< Button variant = "secondary" isQuiet > Save< / Button >
< Button variant = "secondary" > Save< / Button >
< Button variant = "secondary" isQuiet > Save< / Button >
< Button variant = "secondary" >
Save
< / Button >
< Button
variant = "secondary"
isQuiet >
Save
< / Button >
View guidelines
< View backgroundColor = "positive" padding = "size-300" >
< Button variant = "overBackground" > Save< / Button >
< Button variant = "overBackground" isQuiet > Save< / Button >
< / View >
< View backgroundColor = "positive" padding = "size-300" >
< Button variant = "overBackground" > Save< / Button >
< Button variant = "overBackground" isQuiet > Save< / Button >
< / View >
< View
backgroundColor = "positive"
padding = "size-300" >
< Button variant = "overBackground" >
Save
< / Button >
< Button
variant = "overBackground"
isQuiet >
Save
< / Button >
< / View >
View guidelines
< Button variant = "negative" > Save< / Button >
< Button variant = "negative" isQuiet > Save< / Button >
< Button variant = "negative" > Save< / Button >
< Button variant = "negative" isQuiet > Save< / Button >
< Button variant = "negative" >
Save
< / Button >
< Button
variant = "negative"
isQuiet >
Save
< / Button >
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
}
'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