Modal
The Modal component provides a way to display content in a layer that sits above the rest of the page content. It's commonly used for confirmation dialogs, message boxes, and other content that should temporarily block interactions with the main view.
Import
import { Modal } from "@cfa/react-core";Live Editor
Examples
Custom Styling
You can customize the modal’s appearance using CSS classes or inline styles:
Modal with Content Components
The Modal component comes with several content-specific components that help structure the modal according to Design System guidelines. These components include:
Modal.Content- Container for modal contentModal.Title- Title component with proper stylingModal.Footer- Footer component for action buttonsModal.CloseButton- Pre-styled close button
These content components are optional and the Modal can be used without them for a fully customizable solution. Using the components like Title/Content will have all styles applied aside from the layout and spacing styles.
Dismissable Modal
A modal that can be dismissed by clicking outside. When using the Modal.Overlay, this prop needs to be added to the Overlay and not the Dialog.
Controlled Modal
A modal whose open state is controlled by the parent component.
Fullscreen Modal
A modal that takes up the entire viewport.
Custom Overlay
The Modal.Overlay provides a way for you to customize the Overlay itself, a common use case might be to add some z-index if you are seeing
conflicts in your app. Generally you should not need to use this component.
Keep in mind that isDismissable and isKeyboardDismissDisabled will have to be used on the Overlay in this scenario.
Props
Visit the Documentation Site for the full list of props.
| Name | Type | Default | Description |
|---|---|---|---|
| defaultOpen | boolean | - | Whether the overlay is open by default (uncontrolled). |
| isOpen | boolean | - | Whether the overlay is open by default (controlled). |
| onOpenChange | (isOpen: boolean) => void | - | Handler that is called when the overlay's open state changes. |
| Name | Type | Default | Description |
|---|---|---|---|
| isCloseButtonHidden | boolean | false | Removes the close button from Modal |
| isDismissable | boolean | false | Enables the Modal to be closed by clicking outside of the Modal |
| className | ClassNameOrFunction<ModalRenderProps> | 'react-aria-ModalOverlay' | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state. |
| defaultOpen | boolean | - | Whether the overlay is open by default (uncontrolled). |
| dir | string | - | - |
| hidden | boolean | - | - |
| inert | boolean | - | - |
| isEntering | boolean | - | Whether the modal is currently performing an entry animation. |
| isExiting | boolean | - | Whether the modal is currently performing an exit animation. |
| isKeyboardDismissDisabled | boolean | false | Whether pressing the escape key to close the modal should be disabled. |
| isOpen | boolean | - | Whether the overlay is open by default (controlled). |
| lang | string | - | - |
| 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> | - | - |
| onOpenChange | (isOpen: boolean) => void | - | Handler that is called when the overlay's open state changes. |
| 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> | - | - |
| render | DOMRenderFunction<"div", ModalRenderProps> | - | 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: * You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). * Only a single root DOM element can be rendered (no fragments). * You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate. |
| slot | string | - | 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. |
| style | StyleOrFunction<ModalRenderProps> | - | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state. |
| translate | "yes" | "no" | - | - |
| Name | Type | Default | Description |
|---|---|---|---|
| children | ReactNode | - | The children of the component. A function may be provided to alter the children based on component state. |
| fullscreen | boolean | - | - |
| isCloseButtonHidden | boolean | false | Removes the close button from Modal |
| size | "sm" | "md" | "lg" | "xl" | - | - |
| className | ClassNameOrFunction<ModalRenderProps> | 'react-aria-ModalOverlay' | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state. |
| defaultOpen | boolean | - | Whether the overlay is open by default (uncontrolled). |
| dir | string | - | - |
| hidden | boolean | - | - |
| inert | boolean | - | - |
| isDismissable | boolean | false | Whether to close the modal when the user interacts outside it. |
| isEntering | boolean | - | Whether the modal is currently performing an entry animation. |
| isExiting | boolean | - | Whether the modal is currently performing an exit animation. |
| isKeyboardDismissDisabled | boolean | false | Whether pressing the escape key to close the modal should be disabled. |
| isOpen | boolean | - | Whether the overlay is open by default (controlled). |
| lang | string | - | - |
| 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> | - | - |
| onOpenChange | (isOpen: boolean) => void | - | Handler that is called when the overlay's open state changes. |
| 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> | - | - |
| render | DOMRenderFunction<"div", ModalRenderProps> | - | 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: * You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). * Only a single root DOM element can be rendered (no fragments). * You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate. |
| slot | string | - | 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. |
| style | StyleOrFunction<ModalRenderProps> | - | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state. |
| translate | "yes" | "no" | - | - |
| Name | Type | Default | Description |
|---|---|---|---|
| className | string | - | CSS class names to apply custom styling. |
| id | string | - | The unique identifier for the DOM element. |
| role | AriaRole | - | The ARIA role assigned to the element to improve accessibility. Example roles include "button", "navigation", "dialog", etc. |
| style | CSSProperties | - | Inline styles specified as a React-compatible CSS properties object. |
| children | ReactNode | - | The content or child elements nested within this component. |
| level | number | - | - |
| Name | Type | Default | Description |
|---|---|---|---|
| children | ReactNode | - | The content or child elements nested within this component. |
| className | string | - | CSS class names to apply custom styling. |
| id | string | - | The unique identifier for the DOM element. |
| role | AriaRole | - | The ARIA role assigned to the element to improve accessibility. Example roles include "button", "navigation", "dialog", etc. |
| style | CSSProperties | - | Inline styles specified as a React-compatible CSS properties object. |
| Name | Type | Default | Description |
|---|---|---|---|
| children | ReactNode | - | The content or child elements nested within this component. |
| className | string | - | CSS class names to apply custom styling. |
| id | string | - | The unique identifier for the DOM element. |
| role | AriaRole | - | The ARIA role assigned to the element to improve accessibility. Example roles include "button", "navigation", "dialog", etc. |
| style | CSSProperties | - | Inline styles specified as a React-compatible CSS properties object. |
| Name | Type | Default | Description |
|---|---|---|---|
| color | "primary" | "secondary" | - | - |
| fullWidth | boolean | false | Renders the Button in with a fluid width |
| 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 the ability to focus, and announces the pending state to screen readers. |
| ref | Ref<HTMLButtonElement> | - | Requires React 19 |
| size | "sm" | "md" | "lg" | lg | Determines the size of the Button |
| variant | "filled" | "outlined" | "destructive" | "text" | filled | Variant for the button |
| aria-controls | string | - | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
| aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | - | 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 | boolean | "true" | "false" | - | Indicates whether the element is disabled to users of assistive technology. |
| aria-expanded | boolean | "true" | "false" | - | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
| aria-haspopup | boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree" | - | 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 | boolean | "true" | "false" | "mixed" | - | Indicates the current "pressed" state of toggle buttons. |
| autoFocus | boolean | - | Whether the element should receive focus on render. |
| children | ChildrenOrFunction<ButtonRenderProps> | - | The children of the component. A function may be provided to alter the children based on component state. |
| className | ClassNameOrFunction<ButtonRenderProps> | 'react-aria-Button' | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state. |
| 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. |
| 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. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/button#form). |
| 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. |
| hidden | boolean | - | - |
| id | string | - | The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id). |
| inert | boolean | - | - |
| lang | string | - | - |
| name | string | - | Submitted as a pair with the button's value as part of the form data. |
| 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> | - | - |
| 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> | - | - |
| 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. |
| 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: * You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). * Only a single root DOM element can be rendered (no fragments). * You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate. |
| slot | string | - | 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. |
| style | StyleOrFunction<ButtonRenderProps> | - | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state. |
| translate | "yes" | "no" | - | - |
| type | "button" | "submit" | "reset" | '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. |