Button

A button allows a user to perform an action with mouse, touch, or keyboard.

Features

Mouse, touch, keyboard, and focus interactions are normalized to ensure consistency across browsers and devices.
Uses a native <button> element under the hood, with support for the Space and Enter keys.
Hover, press, and keyboard focus states are provided for easy styling. These states only apply when interacting with an appropriate input device, unlike CSS pseudo classes.

Parts and their API

Button

A button allows a user to perform an action with mouse, touch, or keyboard.

Props

Prop	Type	Default	Description
form	string	-	The <form> element to associate the button with. The value of this attribute must be the id of a <form> in the same document.
formAction	string	-	The URL that processes the information submitted by the button. Overrides the action attribute of the button's form owner.
formEncType	string	-	Indicates how to encode the form data that is submitted.
formMethod	string	-	Indicates the HTTP method used to submit the form.
formNoValidate	boolean	-	Indicates that the form is not to be validated when it is submitted.
formTarget	string	-	Overrides the target attribute of the button's form owner.
name	string	-	Submitted as a pair with the button's value as part of the form data.
value	string	-	The value associated with the button's name when it's submitted with the form data.
isDisabled	boolean	-	Whether the button is disabled.
autoFocus	boolean	-	Whether the element should receive focus on render.
type	'button' \| 'submit' \| 'reset'	'button'	The behavior of the button when used in an HTML form.
children	ReactNode \| (values: ButtonRenderProps) => ReactNode	-	The children of the component. A function may be provided to alter the children based on component state.
className	string \| (values: ButtonRenderProps) => string	-	The CSS className for the element. A function may be provided to compute the class based on component state.
style	CSSProperties \| (values: ButtonRenderProps) => CSSProperties	-	The inline style for the element. A function may be provided to compute the style based on component state.

State

Render Prop	CSS Selector	Description
isHovered	[data-hovered]	Whether the button is currently hovered with a mouse.
isPressed	[data-pressed]	Whether the button is currently in a pressed state.
isFocused	[data-focused]	Whether the button is focused, either via a mouse or keyboard.
isFocusVisible	[data-focus-visible]	Whether the button is keyboard focused.
isDisabled	[data-disabled]	Whether the button is disabled.

Events

Name	Type	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<Target>) => void	Handler that is called when the element receives focus.
onBlur	(e: FocusEvent<Target>) => 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.
onHoverStart	(e: HoverEvent) => void	Handler that is called when a hover interaction starts.
onHoverEnd	(e: HoverEvent) => void	Handler that is called when a hover interaction ends.
onHoverChange	(isHovering: boolean) => void	Handler that is called when the hover state changes.

Layout

Name	Type	Description
slot	string \| null	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.

Accessibility

Name	Type	Description
id	string	The element's unique identifier.
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 \| 'true' \| 'false'	Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-haspopup	boolean \| 'menu' \| 'listbox' \| 'tree' \| 'grid' \| 'dialog' \| 'true' \| 'false'	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 \| 'true' \| 'false' \| 'mixed'	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.

Usage

ButtonExample.tsx

<div className="flex gap-6">
	<Button onPress={() => alert('Hello world!')}>Click me</Button>
	<Button onPress={() => alert('Hello world!')} variant="secondary">
		Click me
	</Button>
	<Button onPress={() => alert('Hello world!')} variant="danger">
		Click me
	</Button>
	<Button onPress={() => alert('Hello world!')} variant="ghost">
		Click me
	</Button>
</div>
<div className="mt-8 flex gap-6">
	<Button isDisabled onPress={() => alert('Hello world!')}>
		Click me
	</Button>
	<Button isDisabled onPress={() => alert('Hello world!')} variant="secondary">
		Click me
	</Button>
	<Button isDisabled onPress={() => alert('Hello world!')} variant="danger">
		Click me
	</Button>
	<Button isDisabled onPress={() => alert('Hello world!')} variant="ghost">
		Click me
	</Button>
</div>

Here's the <Button /> component in action.

Source

Get all-access

Styling

tailwind.css

/* ### Buttons ### */
@layer components {
	/* Button */
	/* For cross-browser consistency, React Aria's button give us the button's state using data attributes. We'll be using that instead of hover:, focus-visible:, disabled: and other pseudo class selectors. */
	.button {
		@apply inline-flex items-center justify-center whitespace-nowrap rounded-md text-size-sm font-semibold ring-offset-background transition-colors;
		/* States */
		&[data-focused] {
			@apply outline-none;
		}
		&[data-focus-visible] {
			@apply outline-none ring-2 ring-ring ring-offset-2;
		}
		&[data-disabled] {
			@apply pointer-events-none opacity-50;
		}

		/* Variants */
		&.primary {
			@apply border bg-brand text-muted-50;
			&[data-hovered] {
				@apply bg-brand/90;
			}
			&[data-pressed] {
				@apply bg-brand-bg-hover;
			}
		}
		&.secondary {
			@apply border bg-muted-50 text-muted-800;
			&[data-hovered] {
				@apply bg-muted-100;
			}
			&[data-pressed] {
				@apply bg-muted-200;
			}
		}
		&.danger {
			@apply bg-danger-bg text-danger-foreground;
			&[data-hovered] {
				@apply bg-danger-foreground/10;
			}
			&[data-pressed] {
				@apply bg-danger-foreground/20;
			}
		}
		&.ghost {
			&[data-hovered] {
				@apply bg-muted-100;
			}
			&[data-pressed] {
				@apply bg-muted-300;
			}
		}
		/* Sizes */
		&.lg {
			@apply h-14 px-10 text-size-md;
		}
		&.md {
			@apply h-10 px-4 py-2;
		}
		&.sm {
			@apply h-9 px-3;
		}
	}
}