Accordion
Props
API reference for Accordion. For usage examples, see the React tab.
Accordion.Root
| Name | Type | Default |
|---|---|---|
| allowsMultipleExpanded | boolean | — |
Whether multiple items can be expanded at the same time. | ||
| children | ChildrenOrFunction<DisclosureGroupRenderProps> | — |
The children of the component. A function may be provided to alter the children based on component state. | ||
| defaultExpandedKeys | Iterable<Key> | — |
The initial expanded keys in the group (uncontrolled). | ||
| expandedKeys | Iterable<Key> | — |
The currently expanded keys in the group (controlled). | ||
| isDisabled | boolean | — |
Whether all items are disabled. | ||
| isElevated | boolean | false |
Elevates the accordion, giving it a raised appearance. | ||
| panelPadding | number | — |
| Name | Type | Default |
|---|---|---|
| id | string | — |
The element's unique identifier. See MDN (opens in new tab). | ||
| Name | Type | Default |
|---|---|---|
| dir | string | — |
| hidden | boolean | — |
| inert | boolean | — |
| lang | string | — |
| render | DOMRenderFunction<"div", DisclosureGroupRenderProps> | — |
Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements:
| ||
| suppressHydrationWarning | boolean | — |
A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs (opens in new tab). | ||
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationStart | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAuxClick | MouseEventHandler<HTMLDivElement> | — |
| onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onClick | MouseEventHandler<HTMLDivElement> | — |
| onClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onContextMenu | MouseEventHandler<HTMLDivElement> | — |
| onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — |
| onDoubleClick | MouseEventHandler<HTMLDivElement> | — |
| onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onExpandedChange | ((keys: Set<Key>) => any) | — |
Handler that is called when items are expanded or collapsed. | ||
| onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — |
| onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — |
| onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — |
| onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — |
| onMouseDown | MouseEventHandler<HTMLDivElement> | — |
| onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseEnter | MouseEventHandler<HTMLDivElement> | — |
| onMouseLeave | MouseEventHandler<HTMLDivElement> | — |
| onMouseMove | MouseEventHandler<HTMLDivElement> | — |
| onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseOut | MouseEventHandler<HTMLDivElement> | — |
| onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseOver | MouseEventHandler<HTMLDivElement> | — |
| onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseUp | MouseEventHandler<HTMLDivElement> | — |
| onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — |
| onPointerCancel | PointerEventHandler<HTMLDivElement> | — |
| onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerDown | PointerEventHandler<HTMLDivElement> | — |
| onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerEnter | PointerEventHandler<HTMLDivElement> | — |
| onPointerLeave | PointerEventHandler<HTMLDivElement> | — |
| onPointerMove | PointerEventHandler<HTMLDivElement> | — |
| onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerOut | PointerEventHandler<HTMLDivElement> | — |
| onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerOver | PointerEventHandler<HTMLDivElement> | — |
| onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerUp | PointerEventHandler<HTMLDivElement> | — |
| onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — |
| onScroll | UIEventHandler<HTMLDivElement> | — |
| onScrollCapture | UIEventHandler<HTMLDivElement> | — |
| onTouchCancel | TouchEventHandler<HTMLDivElement> | — |
| onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchEnd | TouchEventHandler<HTMLDivElement> | — |
| onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchMove | TouchEventHandler<HTMLDivElement> | — |
| onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchStart | TouchEventHandler<HTMLDivElement> | — |
| onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — |
| onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionRun | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionStart | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — |
| onWheel | WheelEventHandler<HTMLDivElement> | — |
| onWheelCapture | WheelEventHandler<HTMLDivElement> | — |
| Name | Type | Default |
|---|---|---|
| className | ClassNameOrFunction<DisclosureGroupRenderProps> | 'react-aria-DisclosureGroup' |
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state. | ||
| style | StyleOrFunction<DisclosureGroupRenderProps> | — |
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state. | ||
Accordion.Item
| Name | Type | Default |
|---|---|---|
| children | ChildrenOrFunction<DisclosureRenderProps> | — |
The children of the component. A function may be provided to alter the children based on component state. | ||
| defaultExpanded | boolean | — |
Whether the disclosure is expanded by default (uncontrolled). | ||
| elevated | boolean | — |
Renders the elevated variant of the accordion item | ||
| isDisabled | boolean | — |
Whether the disclosure is disabled. | ||
| isExpanded | boolean | — |
Whether the disclosure is expanded (controlled). | ||
| Name | Type | Default |
|---|---|---|
| id | Key | — |
An id for the disclosure when used within a DisclosureGroup, matching the id used in | ||
| Name | Type | Default |
|---|---|---|
| dir | string | — |
| hidden | boolean | — |
| inert | boolean | — |
| lang | string | — |
| render | DOMRenderFunction<"div", DisclosureRenderProps> | — |
Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements:
| ||
| slot | string | null | — |
A slot name for the component. Slots allow the component to receive props from a parent component. An explicit | ||
| suppressHydrationWarning | boolean | — |
A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs (opens in new tab). | ||
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationStart | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAuxClick | MouseEventHandler<HTMLDivElement> | — |
| onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onClick | MouseEventHandler<HTMLDivElement> | — |
| onClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onContextMenu | MouseEventHandler<HTMLDivElement> | — |
| onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — |
| onDoubleClick | MouseEventHandler<HTMLDivElement> | — |
| onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onExpandedChange | ((isExpanded: boolean) => void) | — |
Handler that is called when the disclosure's expanded state changes. | ||
| onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — |
| onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — |
| onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — |
| onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — |
| onMouseDown | MouseEventHandler<HTMLDivElement> | — |
| onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseEnter | MouseEventHandler<HTMLDivElement> | — |
| onMouseLeave | MouseEventHandler<HTMLDivElement> | — |
| onMouseMove | MouseEventHandler<HTMLDivElement> | — |
| onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseOut | MouseEventHandler<HTMLDivElement> | — |
| onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseOver | MouseEventHandler<HTMLDivElement> | — |
| onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseUp | MouseEventHandler<HTMLDivElement> | — |
| onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — |
| onPointerCancel | PointerEventHandler<HTMLDivElement> | — |
| onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerDown | PointerEventHandler<HTMLDivElement> | — |
| onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerEnter | PointerEventHandler<HTMLDivElement> | — |
| onPointerLeave | PointerEventHandler<HTMLDivElement> | — |
| onPointerMove | PointerEventHandler<HTMLDivElement> | — |
| onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerOut | PointerEventHandler<HTMLDivElement> | — |
| onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerOver | PointerEventHandler<HTMLDivElement> | — |
| onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerUp | PointerEventHandler<HTMLDivElement> | — |
| onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — |
| onScroll | UIEventHandler<HTMLDivElement> | — |
| onScrollCapture | UIEventHandler<HTMLDivElement> | — |
| onTouchCancel | TouchEventHandler<HTMLDivElement> | — |
| onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchEnd | TouchEventHandler<HTMLDivElement> | — |
| onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchMove | TouchEventHandler<HTMLDivElement> | — |
| onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchStart | TouchEventHandler<HTMLDivElement> | — |
| onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — |
| onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionRun | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionStart | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — |
| onWheel | WheelEventHandler<HTMLDivElement> | — |
| onWheelCapture | WheelEventHandler<HTMLDivElement> | — |
| Name | Type | Default |
|---|---|---|
| className | ClassNameOrFunction<DisclosureRenderProps> | 'react-aria-Disclosure' |
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state. | ||
| style | StyleOrFunction<DisclosureRenderProps> | — |
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state. | ||
Accordion.Panel
| Name | Type | Default |
|---|---|---|
| children* (required) | ReactNode | — |
The children of the component. | ||
| label | ReactNode | — |
The content to display as the label. | ||
| labelElementType | ElementType | 'label' |
The HTML element used to render the label, e.g. 'label', or 'span'. | ||
| padding | number | — |
| Name | Type | Default |
|---|---|---|
| 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. | ||
| 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. | ||
| id | string | — |
The element's unique identifier. See MDN (opens in new tab). | ||
| role | "group" | "region" | 'group' |
The accessibility role for the disclosure's panel. | ||
| Name | Type | Default |
|---|---|---|
| dir | string | — |
| hidden | boolean | — |
| inert | boolean | — |
| lang | string | — |
| render | DOMRenderFunction<"div", DisclosurePanelRenderProps> | — |
Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements:
| ||
| suppressHydrationWarning | boolean | — |
A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs (opens in new tab). | ||
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationStart | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAuxClick | MouseEventHandler<HTMLDivElement> | — |
| onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onClick | MouseEventHandler<HTMLDivElement> | — |
| onClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onContextMenu | MouseEventHandler<HTMLDivElement> | — |
| onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — |
| onDoubleClick | MouseEventHandler<HTMLDivElement> | — |
| onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — |
| onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — |
| onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — |
| onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — |
| onMouseDown | MouseEventHandler<HTMLDivElement> | — |
| onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseEnter | MouseEventHandler<HTMLDivElement> | — |
| onMouseLeave | MouseEventHandler<HTMLDivElement> | — |
| onMouseMove | MouseEventHandler<HTMLDivElement> | — |
| onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseOut | MouseEventHandler<HTMLDivElement> | — |
| onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseOver | MouseEventHandler<HTMLDivElement> | — |
| onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseUp | MouseEventHandler<HTMLDivElement> | — |
| onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — |
| onPointerCancel | PointerEventHandler<HTMLDivElement> | — |
| onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerDown | PointerEventHandler<HTMLDivElement> | — |
| onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerEnter | PointerEventHandler<HTMLDivElement> | — |
| onPointerLeave | PointerEventHandler<HTMLDivElement> | — |
| onPointerMove | PointerEventHandler<HTMLDivElement> | — |
| onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerOut | PointerEventHandler<HTMLDivElement> | — |
| onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerOver | PointerEventHandler<HTMLDivElement> | — |
| onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerUp | PointerEventHandler<HTMLDivElement> | — |
| onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — |
| onScroll | UIEventHandler<HTMLDivElement> | — |
| onScrollCapture | UIEventHandler<HTMLDivElement> | — |
| onTouchCancel | TouchEventHandler<HTMLDivElement> | — |
| onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchEnd | TouchEventHandler<HTMLDivElement> | — |
| onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchMove | TouchEventHandler<HTMLDivElement> | — |
| onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchStart | TouchEventHandler<HTMLDivElement> | — |
| onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — |
| onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionRun | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionStart | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — |
| onWheel | WheelEventHandler<HTMLDivElement> | — |
| onWheelCapture | WheelEventHandler<HTMLDivElement> | — |
| Name | Type | Default |
|---|---|---|
| className | ClassNameOrFunction<DisclosurePanelRenderProps> | 'react-aria-DisclosurePanel' |
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state. | ||
| style | StyleOrFunction<DisclosurePanelRenderProps> | — |
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state. | ||
Accordion.Trigger
| Name | Type | Default |
|---|---|---|
| children | ReactNode | — |
The children of the component. A function may be provided to alter the children based on component state. | ||
| isDisabled | boolean | — |
Whether the button is disabled. | ||
| isPending | boolean | — |
Whether the button is in a pending state. This disables press and hover events while retaining focusability, and announces the pending state to screen readers. | ||
| Name | Type | Default |
|---|---|---|
| aria-controls | string | — |
Identifies the element (or elements) whose contents or presence are controlled by the current element. | ||
| aria-current | "date" | "false" | "location" | "page" | "step" | "time" | "true" | boolean | — |
Indicates whether this element represents the current item within a container or set of related elements. | ||
| 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. | ||
| aria-disabled | "false" | "true" | boolean | — |
Indicates whether the element is disabled to users of assistive technology. | ||
| aria-expanded | "false" | "true" | boolean | — |
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | ||
| aria-haspopup | "dialog" | "false" | "grid" | "listbox" | "menu" | "tree" | "true" | boolean | — |
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | ||
| 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-pressed | "false" | "mixed" | "true" | boolean | — |
Indicates the current "pressed" state of toggle buttons. | ||
| id | string | — |
The element's unique identifier. See MDN (opens in new tab). | ||
| Name | Type | Default |
|---|---|---|
| autoFocus | boolean | — |
Whether the element should receive focus on render. | ||
| dir | string | — |
| 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. | ||
| hidden | boolean | — |
| inert | boolean | — |
| lang | string | — |
| preventFocusOnPress | boolean | — |
Whether to prevent focus from moving to the button when pressing it. Caution, this can make the button inaccessible and should only be used when alternative keyboard interaction is provided, such as ComboBox's MenuTrigger or a NumberField's increment/decrement control. | ||
| ref | Ref<HTMLButtonElement> | — |
Requires React 19 | ||
| render | DOMRenderFunction<"button", ButtonRenderProps> | — |
Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements:
| ||
| slot | string | null | — |
A slot name for the component. Slots allow the component to receive props from a parent component. An explicit | ||
| suppressHydrationWarning | boolean | — |
A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs (opens in new tab). | ||
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| onAnimationEnd | AnimationEventHandler<HTMLButtonElement> | — |
| onAnimationEndCapture | AnimationEventHandler<HTMLButtonElement> | — |
| onAnimationIteration | AnimationEventHandler<HTMLButtonElement> | — |
| onAnimationIterationCapture | AnimationEventHandler<HTMLButtonElement> | — |
| onAnimationStart | AnimationEventHandler<HTMLButtonElement> | — |
| onAnimationStartCapture | AnimationEventHandler<HTMLButtonElement> | — |
| onAuxClick | MouseEventHandler<HTMLButtonElement> | — |
| onAuxClickCapture | MouseEventHandler<HTMLButtonElement> | — |
| onBlur | ((e: FocusEvent<Element, Element>) => void) | — |
Handler that is called when the element loses focus. | ||
| onClickCapture | MouseEventHandler<HTMLButtonElement> | — |
| onContextMenu | MouseEventHandler<HTMLButtonElement> | — |
| onContextMenuCapture | MouseEventHandler<HTMLButtonElement> | — |
| onDoubleClick | MouseEventHandler<HTMLButtonElement> | — |
| onDoubleClickCapture | MouseEventHandler<HTMLButtonElement> | — |
| onFocus | ((e: FocusEvent<Element, Element>) => void) | — |
Handler that is called when the element receives focus. | ||
| onFocusChange | ((isFocused: boolean) => void) | — |
Handler that is called when the element's focus status changes. | ||
| onGotPointerCapture | PointerEventHandler<HTMLButtonElement> | — |
| onGotPointerCaptureCapture | PointerEventHandler<HTMLButtonElement> | — |
| onHoverChange | ((isHovering: boolean) => void) | — |
Handler that is called when the hover state changes. | ||
| onHoverEnd | ((e: HoverEvent) => void) | — |
Handler that is called when a hover interaction ends. | ||
| onHoverStart | ((e: HoverEvent) => void) | — |
Handler that is called when a hover interaction starts. | ||
| 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. | ||
| onLostPointerCapture | PointerEventHandler<HTMLButtonElement> | — |
| onLostPointerCaptureCapture | PointerEventHandler<HTMLButtonElement> | — |
| onMouseDown | MouseEventHandler<HTMLButtonElement> | — |
| onMouseDownCapture | MouseEventHandler<HTMLButtonElement> | — |
| onMouseEnter | MouseEventHandler<HTMLButtonElement> | — |
| onMouseLeave | MouseEventHandler<HTMLButtonElement> | — |
| onMouseMove | MouseEventHandler<HTMLButtonElement> | — |
| onMouseMoveCapture | MouseEventHandler<HTMLButtonElement> | — |
| onMouseOut | MouseEventHandler<HTMLButtonElement> | — |
| onMouseOutCapture | MouseEventHandler<HTMLButtonElement> | — |
| onMouseOver | MouseEventHandler<HTMLButtonElement> | — |
| onMouseOverCapture | MouseEventHandler<HTMLButtonElement> | — |
| onMouseUp | MouseEventHandler<HTMLButtonElement> | — |
| onMouseUpCapture | MouseEventHandler<HTMLButtonElement> | — |
| onPointerCancel | PointerEventHandler<HTMLButtonElement> | — |
| onPointerCancelCapture | PointerEventHandler<HTMLButtonElement> | — |
| onPointerDown | PointerEventHandler<HTMLButtonElement> | — |
| onPointerDownCapture | PointerEventHandler<HTMLButtonElement> | — |
| onPointerEnter | PointerEventHandler<HTMLButtonElement> | — |
| onPointerLeave | PointerEventHandler<HTMLButtonElement> | — |
| onPointerMove | PointerEventHandler<HTMLButtonElement> | — |
| onPointerMoveCapture | PointerEventHandler<HTMLButtonElement> | — |
| onPointerOut | PointerEventHandler<HTMLButtonElement> | — |
| onPointerOutCapture | PointerEventHandler<HTMLButtonElement> | — |
| onPointerOver | PointerEventHandler<HTMLButtonElement> | — |
| onPointerOverCapture | PointerEventHandler<HTMLButtonElement> | — |
| onPointerUp | PointerEventHandler<HTMLButtonElement> | — |
| onPointerUpCapture | PointerEventHandler<HTMLButtonElement> | — |
| onPress | ((e: PressEvent) => void) | — |
Handler that is called when the press is released over the target. | ||
| onPressChange | ((isPressed: boolean) => void) | — |
Handler that is called when the press state changes. | ||
| onPressEnd | ((e: PressEvent) => void) | — |
Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target. | ||
| onPressStart | ((e: PressEvent) => void) | — |
Handler that is called when a press interaction starts. | ||
| 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. | ||
| onScroll | UIEventHandler<HTMLButtonElement> | — |
| onScrollCapture | UIEventHandler<HTMLButtonElement> | — |
| onTouchCancel | TouchEventHandler<HTMLButtonElement> | — |
| onTouchCancelCapture | TouchEventHandler<HTMLButtonElement> | — |
| onTouchEnd | TouchEventHandler<HTMLButtonElement> | — |
| onTouchEndCapture | TouchEventHandler<HTMLButtonElement> | — |
| onTouchMove | TouchEventHandler<HTMLButtonElement> | — |
| onTouchMoveCapture | TouchEventHandler<HTMLButtonElement> | — |
| onTouchStart | TouchEventHandler<HTMLButtonElement> | — |
| onTouchStartCapture | TouchEventHandler<HTMLButtonElement> | — |
| onTransitionCancel | TransitionEventHandler<HTMLButtonElement> | — |
| onTransitionCancelCapture | TransitionEventHandler<HTMLButtonElement> | — |
| onTransitionEnd | TransitionEventHandler<HTMLButtonElement> | — |
| onTransitionEndCapture | TransitionEventHandler<HTMLButtonElement> | — |
| onTransitionRun | TransitionEventHandler<HTMLButtonElement> | — |
| onTransitionRunCapture | TransitionEventHandler<HTMLButtonElement> | — |
| onTransitionStart | TransitionEventHandler<HTMLButtonElement> | — |
| onTransitionStartCapture | TransitionEventHandler<HTMLButtonElement> | — |
| onWheel | WheelEventHandler<HTMLButtonElement> | — |
| onWheelCapture | WheelEventHandler<HTMLButtonElement> | — |
| Name | Type | Default |
|---|---|---|
| form | string | — |
The | ||
| formAction | string | ((formData: FormData) => void | Promise<void>) | — |
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. | ||
| type | "button" | "reset" | "submit" | 'button' |
The behavior of the button when used in an HTML form. | ||
| value | string | — |
The value associated with the button's name when it's submitted with the form data. | ||
| Name | Type | Default |
|---|---|---|
| className | ClassNameOrFunction<ButtonRenderProps> | 'react-aria-Button' |
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state. | ||
| style | StyleOrFunction<ButtonRenderProps> | — |
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state. | ||