DateRangePicker
This component is in beta
While fully functional, the API may change depending on user feedback. We encourage you to try it out and share your experience, as this will help us improve component functionality and stability.A date range picker combines two DateFields and a RangeCalendar popover to allow users to enter or select a date range.
Import
import { UNSTABLE_DateRangePicker as DateRangePicker } from "@cfa/react-core";import { UNSTABLE_DateRangeField as DateRangeField } from "@cfa/react-core";Live Editor
Examples
Basic Usage
The most common way to use DateRangePicker is with the composite component.
Composable Usage
For more control and customization, use the individual DateRangeField subcomponents.
Controlled Usage
Control the date range value from a parent component.
Date Range Constraints
Set minimum and maximum dates to restrict the selectable range.
Unavailable Dates
Disable specific dates using the isDateUnavailable prop. The example below prevents selection of weekends.
Date Highlighting
Highlight specific dates in the calendar using the isDateHighlighted prop. This example highlights the 1st and 15th of each month.
Non-Contiguous Ranges
Allow users to select non-contiguous date ranges for more flexible selection.
Validation States
The DateRangePicker component supports different validation states.
Date and Time Ranges
Use different granularities for date and time range selection.
Custom Calendar Display
Customize the calendar display with different first day of week and visible duration.
Compact Variant
For smaller spaces, use the compact variant.
Props
Visit the Documentation Site for the full list of props.
| Name | Type | Default | Description |
|---|---|---|---|
| compact | boolean | false | Renders a compact version of the DateRangePicker |
| description | string | - | Description for the date range picker |
| errorMessage | string | ((validation: ValidationResult) => string) | - | Error message to display when isInvalid is true |
| isDateHighlighted | (date: T) => boolean | - | - |
| isReadOnly | boolean | - | Makes the date range picker read-only when true |
| label | string | - | Label for the date range picker |
| allowsNonContiguousRanges | boolean | - | When combined with `isDateUnavailable`, determines whether non-contiguous ranges, i.e. ranges containing unavailable dates, may be selected. |
| 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. |
| autoFocus | boolean | - | Whether the element should receive focus on render. |
| children | ChildrenOrFunction<DateRangePickerRenderProps> | - | The children of the component. A function may be provided to alter the children based on component state. |
| className | ClassNameOrFunction<DateRangePickerRenderProps> | 'react-aria-DateRangePicker' | 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). |
| defaultValue | RangeValue<T> | - | The default value (uncontrolled). |
| dir | string | - | - |
| endName | string | - | The name of the end date input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname). |
| firstDayOfWeek | "sun" | "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | - | The day that starts the week. |
| form | string | - | The `<form>` element to associate the input 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/input#form). |
| granularity | Granularity | - | Determines the smallest unit that is displayed in the date picker. By default, this is `"day"` for dates, and `"minute"` for times. |
| hidden | boolean | - | - |
| hideTimeZone | boolean | false | Whether to hide the time zone abbreviation. |
| hourCycle | 12 | 24 | - | Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale. |
| id | string | - | The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id). |
| inert | boolean | - | - |
| isDateUnavailable | (date: DateValue) => boolean | - | Callback that is called for each date of the calendar. If it returns true, then the date is unavailable. |
| isDisabled | boolean | - | Whether the input is disabled. |
| isInvalid | boolean | - | Whether the input value is invalid. |
| isOpen | boolean | - | Whether the overlay is open by default (controlled). |
| isRequired | boolean | - | Whether user input is required on the input before form submission. |
| lang | string | - | - |
| maxValue | DateValue | - | The maximum allowed date that a user may select. |
| minValue | DateValue | - | The minimum allowed date that a user may select. |
| onAnimationEnd | AnimationEventHandler<HTMLDivElement> | - | - |
| onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | - | - |
| onAnimationIteration | AnimationEventHandler<HTMLDivElement> | - | - |
| onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | - | - |
| onAnimationStart | AnimationEventHandler<HTMLDivElement> | - | - |
| onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | - | - |
| onAuxClick | MouseEventHandler<HTMLDivElement> | - | - |
| onAuxClickCapture | MouseEventHandler<HTMLDivElement> | - | - |
| onBlur | (e: FocusEvent<Element, Element>) => void | - | Handler that is called when the element loses focus. |
| onChange | (value: RangeValue<MappedDateValue<T>>) => void | - | Handler that is called when the value changes. |
| onClick | MouseEventHandler<HTMLDivElement> | - | - |
| onClickCapture | MouseEventHandler<HTMLDivElement> | - | - |
| onContextMenu | MouseEventHandler<HTMLDivElement> | - | - |
| onContextMenuCapture | MouseEventHandler<HTMLDivElement> | - | - |
| onDoubleClick | MouseEventHandler<HTMLDivElement> | - | - |
| onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | - | - |
| 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<HTMLDivElement> | - | - |
| onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | - | - |
| 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<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> | - | - |
| pageBehavior | PageBehavior | visible | Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration. |
| placeholderValue | DateValue | - | A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight. |
| render | DOMRenderFunction<"div", DateRangePickerRenderProps> | - | 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. |
| shouldCloseOnSelect | boolean | (() => boolean) | true | Determines whether the date picker popover should close automatically when a date is selected. |
| shouldForceLeadingZeros | boolean | - | Whether to always show leading zeros in the month, day, and hour fields. By default, this is determined by the user's locale. |
| 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. |
| startName | string | - | The name of the start date input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname). |
| style | StyleOrFunction<DateRangePickerRenderProps> | - | 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" | - | - |
| validate | (value: RangeValue<MappedDateValue<T>>) => true | ValidationError | - | A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead. |
| validationBehavior | "native" | "aria" | 'native' | Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA. |
| value | RangeValue<T> | - | The current value (controlled). |
| visibleDuration | DateDuration | {months: 1} | The amount of days that will be displayed at once. This affects how pagination works. |
| Name | Type | Default | Description |
|---|---|---|---|
| compact | boolean | false | Renders a compact version of the DateRangePicker |
| description | string | - | Description for the date range picker |
| errorMessage | string | ((validation: ValidationResult) => string) | - | Error message to display when isInvalid is true |
| isDateHighlighted | (date: T) => boolean | - | - |
| isReadOnly | boolean | - | Makes the date range picker read-only when true |
| label | string | - | Label for the date range picker |
| allowsNonContiguousRanges | boolean | - | When combined with `isDateUnavailable`, determines whether non-contiguous ranges, i.e. ranges containing unavailable dates, may be selected. |
| 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. |
| autoFocus | boolean | - | Whether the element should receive focus on render. |
| children | ChildrenOrFunction<DateRangePickerRenderProps> | - | The children of the component. A function may be provided to alter the children based on component state. |
| className | ClassNameOrFunction<DateRangePickerRenderProps> | 'react-aria-DateRangePicker' | 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). |
| defaultValue | RangeValue<T> | - | The default value (uncontrolled). |
| dir | string | - | - |
| endName | string | - | The name of the end date input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname). |
| firstDayOfWeek | "sun" | "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | - | The day that starts the week. |
| form | string | - | The `<form>` element to associate the input 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/input#form). |
| granularity | Granularity | - | Determines the smallest unit that is displayed in the date picker. By default, this is `"day"` for dates, and `"minute"` for times. |
| hidden | boolean | - | - |
| hideTimeZone | boolean | false | Whether to hide the time zone abbreviation. |
| hourCycle | 12 | 24 | - | Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale. |
| id | string | - | The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id). |
| inert | boolean | - | - |
| isDateUnavailable | (date: DateValue) => boolean | - | Callback that is called for each date of the calendar. If it returns true, then the date is unavailable. |
| isDisabled | boolean | - | Whether the input is disabled. |
| isInvalid | boolean | - | Whether the input value is invalid. |
| isOpen | boolean | - | Whether the overlay is open by default (controlled). |
| isRequired | boolean | - | Whether user input is required on the input before form submission. |
| lang | string | - | - |
| maxValue | DateValue | - | The maximum allowed date that a user may select. |
| minValue | DateValue | - | The minimum allowed date that a user may select. |
| onAnimationEnd | AnimationEventHandler<HTMLDivElement> | - | - |
| onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | - | - |
| onAnimationIteration | AnimationEventHandler<HTMLDivElement> | - | - |
| onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | - | - |
| onAnimationStart | AnimationEventHandler<HTMLDivElement> | - | - |
| onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | - | - |
| onAuxClick | MouseEventHandler<HTMLDivElement> | - | - |
| onAuxClickCapture | MouseEventHandler<HTMLDivElement> | - | - |
| onBlur | (e: FocusEvent<Element, Element>) => void | - | Handler that is called when the element loses focus. |
| onChange | (value: RangeValue<MappedDateValue<T>>) => void | - | Handler that is called when the value changes. |
| onClick | MouseEventHandler<HTMLDivElement> | - | - |
| onClickCapture | MouseEventHandler<HTMLDivElement> | - | - |
| onContextMenu | MouseEventHandler<HTMLDivElement> | - | - |
| onContextMenuCapture | MouseEventHandler<HTMLDivElement> | - | - |
| onDoubleClick | MouseEventHandler<HTMLDivElement> | - | - |
| onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | - | - |
| 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<HTMLDivElement> | - | - |
| onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | - | - |
| 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<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> | - | - |
| pageBehavior | PageBehavior | visible | Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration. |
| placeholderValue | DateValue | - | A placeholder date that influences the format of the placeholder shown when no value is selected. Defaults to today's date at midnight. |
| render | DOMRenderFunction<"div", DateRangePickerRenderProps> | - | 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. |
| shouldCloseOnSelect | boolean | (() => boolean) | true | Determines whether the date picker popover should close automatically when a date is selected. |
| shouldForceLeadingZeros | boolean | - | Whether to always show leading zeros in the month, day, and hour fields. By default, this is determined by the user's locale. |
| 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. |
| startName | string | - | The name of the start date input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname). |
| style | StyleOrFunction<DateRangePickerRenderProps> | - | 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" | - | - |
| validate | (value: RangeValue<MappedDateValue<T>>) => true | ValidationError | - | A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead. |
| validationBehavior | "native" | "aria" | 'native' | Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA. |
| value | RangeValue<T> | - | The current value (controlled). |
| visibleDuration | DateDuration | {months: 1} | The amount of days that will be displayed at once. This affects how pagination works. |
| Name | Type | Default | Description |
|---|---|---|---|
| isDisabled | boolean | - | Whether the Label is on a disabled input or element. |
| isRequired | boolean | - | Whether the Label is on a required input or element. |
| about | string | - | - |
| accessKey | string | - | - |
| aria-activedescendant | string | - | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
| aria-atomic | Booleanish | - | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. |
| aria-autocomplete | "none" | "list" | "inline" | "both" | - | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. |
| aria-braillelabel | string | - | Defines a string value that labels the current element, which is intended to be converted into Braille. @see aria-label. |
| aria-brailleroledescription | string | - | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. @see aria-roledescription. |
| aria-busy | Booleanish | - | - |
| aria-checked | boolean | "true" | "false" | "mixed" | - | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. @see aria-pressed @see aria-selected. |
| aria-colcount | number | - | Defines the total number of columns in a table, grid, or treegrid. @see aria-colindex. |
| aria-colindex | number | - | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. @see aria-colcount @see aria-colspan. |
| aria-colindextext | string | - | Defines a human readable text alternative of aria-colindex. @see aria-rowindextext. |
| aria-colspan | number | - | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-colindex @see aria-rowspan. |
| aria-controls | string | - | Identifies the element (or elements) whose contents or presence are controlled by the current element. @see aria-owns. |
| aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | - | Indicates the element that represents the current item within a container or set of related elements. |
| aria-describedby | string | - | Identifies the element (or elements) that describes the object. @see aria-labelledby |
| aria-description | string | - | Defines a string value that describes or annotates the current element. @see related aria-describedby. |
| aria-details | string | - | Identifies the element that provides a detailed, extended description for the object. @see aria-describedby. |
| aria-disabled | Booleanish | - | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. @see aria-hidden @see aria-readonly. |
| aria-dropeffect | "none" | "link" | "copy" | "execute" | "move" | "popup" | - | Indicates what functions can be performed when a dragged object is released on the drop target. @deprecated in ARIA 1.1 |
| aria-errormessage | string | - | Identifies the element that provides an error message for the object. @see aria-invalid @see aria-describedby. |
| aria-expanded | Booleanish | - | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
| aria-flowto | string | - | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. |
| aria-grabbed | Booleanish | - | Indicates an element's "grabbed" state in a drag-and-drop operation. @deprecated in ARIA 1.1 |
| 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-hidden | Booleanish | - | Indicates whether the element is exposed to an accessibility API. @see aria-disabled. |
| aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | - | Indicates the entered value does not conform to the format expected by the application. @see aria-errormessage. |
| aria-keyshortcuts | string | - | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
| aria-label | string | - | Defines a string value that labels the current element. @see aria-labelledby. |
| aria-labelledby | string | - | Identifies the element (or elements) that labels the current element. @see aria-describedby. |
| aria-level | number | - | Defines the hierarchical level of an element within a structure. |
| aria-live | "off" | "assertive" | "polite" | - | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. |
| aria-modal | Booleanish | - | Indicates whether an element is modal when displayed. |
| aria-multiline | Booleanish | - | Indicates whether a text box accepts multiple lines of input or only a single line. |
| aria-multiselectable | Booleanish | - | Indicates that the user may select more than one item from the current selectable descendants. |
| aria-orientation | "horizontal" | "vertical" | - | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. |
| 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. @see aria-controls. |
| aria-placeholder | string | - | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. |
| aria-posinset | number | - | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-setsize. |
| aria-pressed | boolean | "true" | "false" | "mixed" | - | Indicates the current "pressed" state of toggle buttons. @see aria-checked @see aria-selected. |
| aria-readonly | Booleanish | - | Indicates that the element is not editable, but is otherwise operable. @see aria-disabled. |
| aria-relevant | "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | - | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. @see aria-atomic. |
| aria-required | Booleanish | - | Indicates that user input is required on the element before a form may be submitted. |
| aria-roledescription | string | - | Defines a human-readable, author-localized description for the role of an element. |
| aria-rowcount | number | - | Defines the total number of rows in a table, grid, or treegrid. @see aria-rowindex. |
| aria-rowindex | number | - | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. @see aria-rowcount @see aria-rowspan. |
| aria-rowindextext | string | - | Defines a human readable text alternative of aria-rowindex. @see aria-colindextext. |
| aria-rowspan | number | - | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-rowindex @see aria-colspan. |
| aria-selected | Booleanish | - | Indicates the current "selected" state of various widgets. @see aria-checked @see aria-pressed. |
| aria-setsize | number | - | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-posinset. |
| aria-sort | "none" | "ascending" | "descending" | "other" | - | Indicates if items in a table or grid are sorted in ascending or descending order. |
| aria-valuemax | number | - | Defines the maximum allowed value for a range widget. |
| aria-valuemin | number | - | Defines the minimum allowed value for a range widget. |
| aria-valuenow | number | - | Defines the current value for a range widget. @see aria-valuetext. |
| aria-valuetext | string | - | Defines the human readable text alternative of aria-valuenow for a range widget. |
| autoCapitalize | "off" | "none" | "on" | "sentences" | "words" | "characters" | (string & {}) | - | - |
| autoCorrect | string | - | - |
| autoFocus | boolean | - | - |
| autoSave | string | - | - |
| className | string | - | - |
| color | string | - | - |
| content | string | - | - |
| contentEditable | Booleanish | "inherit" | "plaintext-only" | - | - |
| contextMenu | string | - | - |
| dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | - | - |
| datatype | string | - | - |
| defaultChecked | boolean | - | - |
| defaultValue | string | number | readonly string[] | - | - |
| dir | string | - | - |
| draggable | Booleanish | - | - |
| elementType | string | - | - |
| enterKeyHint | "enter" | "done" | "go" | "next" | "previous" | "search" | "send" | - | - |
| exportparts | string | - | @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts} |
| form | string | - | - |
| hidden | boolean | - | - |
| htmlFor | string | - | - |
| id | string | - | - |
| inert | boolean | - | @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert |
| inlist | any | - | - |
| inputMode | "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | - | Hints at the type of data that might be entered by the user while editing the element or its contents @see {@link https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute} |
| is | string | - | Specify that a standard HTML element should behave like a defined custom built-in element @see {@link https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is} |
| itemID | string | - | - |
| itemProp | string | - | - |
| itemRef | string | - | - |
| itemScope | boolean | - | - |
| itemType | string | - | - |
| lang | string | - | - |
| nonce | string | - | - |
| onAbort | ReactEventHandler<HTMLLabelElement> | - | - |
| onAbortCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onAnimationEnd | AnimationEventHandler<HTMLLabelElement> | - | - |
| onAnimationEndCapture | AnimationEventHandler<HTMLLabelElement> | - | - |
| onAnimationIteration | AnimationEventHandler<HTMLLabelElement> | - | - |
| onAnimationIterationCapture | AnimationEventHandler<HTMLLabelElement> | - | - |
| onAnimationStart | AnimationEventHandler<HTMLLabelElement> | - | - |
| onAnimationStartCapture | AnimationEventHandler<HTMLLabelElement> | - | - |
| onAuxClick | MouseEventHandler<HTMLLabelElement> | - | - |
| onAuxClickCapture | MouseEventHandler<HTMLLabelElement> | - | - |
| onBeforeInput | InputEventHandler<HTMLLabelElement> | - | - |
| onBeforeInputCapture | FormEventHandler<HTMLLabelElement> | - | - |
| onBeforeToggle | ToggleEventHandler<HTMLLabelElement> | - | - |
| onBlur | FocusEventHandler<HTMLLabelElement> | - | - |
| onBlurCapture | FocusEventHandler<HTMLLabelElement> | - | - |
| onCanPlay | ReactEventHandler<HTMLLabelElement> | - | - |
| onCanPlayCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onCanPlayThrough | ReactEventHandler<HTMLLabelElement> | - | - |
| onCanPlayThroughCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onChange | FormEventHandler<HTMLLabelElement> | - | - |
| onChangeCapture | FormEventHandler<HTMLLabelElement> | - | - |
| onClick | MouseEventHandler<HTMLLabelElement> | - | - |
| onClickCapture | MouseEventHandler<HTMLLabelElement> | - | - |
| onCompositionEnd | CompositionEventHandler<HTMLLabelElement> | - | - |
| onCompositionEndCapture | CompositionEventHandler<HTMLLabelElement> | - | - |
| onCompositionStart | CompositionEventHandler<HTMLLabelElement> | - | - |
| onCompositionStartCapture | CompositionEventHandler<HTMLLabelElement> | - | - |
| onCompositionUpdate | CompositionEventHandler<HTMLLabelElement> | - | - |
| onCompositionUpdateCapture | CompositionEventHandler<HTMLLabelElement> | - | - |
| onContextMenu | MouseEventHandler<HTMLLabelElement> | - | - |
| onContextMenuCapture | MouseEventHandler<HTMLLabelElement> | - | - |
| onCopy | ClipboardEventHandler<HTMLLabelElement> | - | - |
| onCopyCapture | ClipboardEventHandler<HTMLLabelElement> | - | - |
| onCut | ClipboardEventHandler<HTMLLabelElement> | - | - |
| onCutCapture | ClipboardEventHandler<HTMLLabelElement> | - | - |
| onDoubleClick | MouseEventHandler<HTMLLabelElement> | - | - |
| onDoubleClickCapture | MouseEventHandler<HTMLLabelElement> | - | - |
| onDrag | DragEventHandler<HTMLLabelElement> | - | - |
| onDragCapture | DragEventHandler<HTMLLabelElement> | - | - |
| onDragEnd | DragEventHandler<HTMLLabelElement> | - | - |
| onDragEndCapture | DragEventHandler<HTMLLabelElement> | - | - |
| onDragEnter | DragEventHandler<HTMLLabelElement> | - | - |
| onDragEnterCapture | DragEventHandler<HTMLLabelElement> | - | - |
| onDragExit | DragEventHandler<HTMLLabelElement> | - | - |
| onDragExitCapture | DragEventHandler<HTMLLabelElement> | - | - |
| onDragLeave | DragEventHandler<HTMLLabelElement> | - | - |
| onDragLeaveCapture | DragEventHandler<HTMLLabelElement> | - | - |
| onDragOver | DragEventHandler<HTMLLabelElement> | - | - |
| onDragOverCapture | DragEventHandler<HTMLLabelElement> | - | - |
| onDragStart | DragEventHandler<HTMLLabelElement> | - | - |
| onDragStartCapture | DragEventHandler<HTMLLabelElement> | - | - |
| onDrop | DragEventHandler<HTMLLabelElement> | - | - |
| onDropCapture | DragEventHandler<HTMLLabelElement> | - | - |
| onDurationChange | ReactEventHandler<HTMLLabelElement> | - | - |
| onDurationChangeCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onEmptied | ReactEventHandler<HTMLLabelElement> | - | - |
| onEmptiedCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onEncrypted | ReactEventHandler<HTMLLabelElement> | - | - |
| onEncryptedCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onEnded | ReactEventHandler<HTMLLabelElement> | - | - |
| onEndedCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onError | ReactEventHandler<HTMLLabelElement> | - | - |
| onErrorCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onFocus | FocusEventHandler<HTMLLabelElement> | - | - |
| onFocusCapture | FocusEventHandler<HTMLLabelElement> | - | - |
| onGotPointerCapture | PointerEventHandler<HTMLLabelElement> | - | - |
| onGotPointerCaptureCapture | PointerEventHandler<HTMLLabelElement> | - | - |
| onInput | FormEventHandler<HTMLLabelElement> | - | - |
| onInputCapture | FormEventHandler<HTMLLabelElement> | - | - |
| onInvalid | FormEventHandler<HTMLLabelElement> | - | - |
| onInvalidCapture | FormEventHandler<HTMLLabelElement> | - | - |
| onKeyDown | KeyboardEventHandler<HTMLLabelElement> | - | - |
| onKeyDownCapture | KeyboardEventHandler<HTMLLabelElement> | - | - |
| onKeyPress | KeyboardEventHandler<HTMLLabelElement> | - | @deprecated Use `onKeyUp` or `onKeyDown` instead |
| onKeyPressCapture | KeyboardEventHandler<HTMLLabelElement> | - | @deprecated Use `onKeyUpCapture` or `onKeyDownCapture` instead |
| onKeyUp | KeyboardEventHandler<HTMLLabelElement> | - | - |
| onKeyUpCapture | KeyboardEventHandler<HTMLLabelElement> | - | - |
| onLoad | ReactEventHandler<HTMLLabelElement> | - | - |
| onLoadCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onLoadedData | ReactEventHandler<HTMLLabelElement> | - | - |
| onLoadedDataCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onLoadedMetadata | ReactEventHandler<HTMLLabelElement> | - | - |
| onLoadedMetadataCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onLoadStart | ReactEventHandler<HTMLLabelElement> | - | - |
| onLoadStartCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onLostPointerCapture | PointerEventHandler<HTMLLabelElement> | - | - |
| onLostPointerCaptureCapture | PointerEventHandler<HTMLLabelElement> | - | - |
| onMouseDown | MouseEventHandler<HTMLLabelElement> | - | - |
| onMouseDownCapture | MouseEventHandler<HTMLLabelElement> | - | - |
| onMouseEnter | MouseEventHandler<HTMLLabelElement> | - | - |
| onMouseLeave | MouseEventHandler<HTMLLabelElement> | - | - |
| onMouseMove | MouseEventHandler<HTMLLabelElement> | - | - |
| onMouseMoveCapture | MouseEventHandler<HTMLLabelElement> | - | - |
| onMouseOut | MouseEventHandler<HTMLLabelElement> | - | - |
| onMouseOutCapture | MouseEventHandler<HTMLLabelElement> | - | - |
| onMouseOver | MouseEventHandler<HTMLLabelElement> | - | - |
| onMouseOverCapture | MouseEventHandler<HTMLLabelElement> | - | - |
| onMouseUp | MouseEventHandler<HTMLLabelElement> | - | - |
| onMouseUpCapture | MouseEventHandler<HTMLLabelElement> | - | - |
| onPaste | ClipboardEventHandler<HTMLLabelElement> | - | - |
| onPasteCapture | ClipboardEventHandler<HTMLLabelElement> | - | - |
| onPause | ReactEventHandler<HTMLLabelElement> | - | - |
| onPauseCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onPlay | ReactEventHandler<HTMLLabelElement> | - | - |
| onPlayCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onPlaying | ReactEventHandler<HTMLLabelElement> | - | - |
| onPlayingCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onPointerCancel | PointerEventHandler<HTMLLabelElement> | - | - |
| onPointerCancelCapture | PointerEventHandler<HTMLLabelElement> | - | - |
| onPointerDown | PointerEventHandler<HTMLLabelElement> | - | - |
| onPointerDownCapture | PointerEventHandler<HTMLLabelElement> | - | - |
| onPointerEnter | PointerEventHandler<HTMLLabelElement> | - | - |
| onPointerLeave | PointerEventHandler<HTMLLabelElement> | - | - |
| onPointerMove | PointerEventHandler<HTMLLabelElement> | - | - |
| onPointerMoveCapture | PointerEventHandler<HTMLLabelElement> | - | - |
| onPointerOut | PointerEventHandler<HTMLLabelElement> | - | - |
| onPointerOutCapture | PointerEventHandler<HTMLLabelElement> | - | - |
| onPointerOver | PointerEventHandler<HTMLLabelElement> | - | - |
| onPointerOverCapture | PointerEventHandler<HTMLLabelElement> | - | - |
| onPointerUp | PointerEventHandler<HTMLLabelElement> | - | - |
| onPointerUpCapture | PointerEventHandler<HTMLLabelElement> | - | - |
| onProgress | ReactEventHandler<HTMLLabelElement> | - | - |
| onProgressCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onRateChange | ReactEventHandler<HTMLLabelElement> | - | - |
| onRateChangeCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onReset | FormEventHandler<HTMLLabelElement> | - | - |
| onResetCapture | FormEventHandler<HTMLLabelElement> | - | - |
| onScroll | UIEventHandler<HTMLLabelElement> | - | - |
| onScrollCapture | UIEventHandler<HTMLLabelElement> | - | - |
| onScrollEnd | UIEventHandler<HTMLLabelElement> | - | - |
| onScrollEndCapture | UIEventHandler<HTMLLabelElement> | - | - |
| onSeeked | ReactEventHandler<HTMLLabelElement> | - | - |
| onSeekedCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onSeeking | ReactEventHandler<HTMLLabelElement> | - | - |
| onSeekingCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onSelect | ReactEventHandler<HTMLLabelElement> | - | - |
| onSelectCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onStalled | ReactEventHandler<HTMLLabelElement> | - | - |
| onStalledCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onSubmit | FormEventHandler<HTMLLabelElement> | - | - |
| onSubmitCapture | FormEventHandler<HTMLLabelElement> | - | - |
| onSuspend | ReactEventHandler<HTMLLabelElement> | - | - |
| onSuspendCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onTimeUpdate | ReactEventHandler<HTMLLabelElement> | - | - |
| onTimeUpdateCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onToggle | ToggleEventHandler<HTMLLabelElement> | - | - |
| onTouchCancel | TouchEventHandler<HTMLLabelElement> | - | - |
| onTouchCancelCapture | TouchEventHandler<HTMLLabelElement> | - | - |
| onTouchEnd | TouchEventHandler<HTMLLabelElement> | - | - |
| onTouchEndCapture | TouchEventHandler<HTMLLabelElement> | - | - |
| onTouchMove | TouchEventHandler<HTMLLabelElement> | - | - |
| onTouchMoveCapture | TouchEventHandler<HTMLLabelElement> | - | - |
| onTouchStart | TouchEventHandler<HTMLLabelElement> | - | - |
| onTouchStartCapture | TouchEventHandler<HTMLLabelElement> | - | - |
| onTransitionCancel | TransitionEventHandler<HTMLLabelElement> | - | - |
| onTransitionCancelCapture | TransitionEventHandler<HTMLLabelElement> | - | - |
| onTransitionEnd | TransitionEventHandler<HTMLLabelElement> | - | - |
| onTransitionEndCapture | TransitionEventHandler<HTMLLabelElement> | - | - |
| onTransitionRun | TransitionEventHandler<HTMLLabelElement> | - | - |
| onTransitionRunCapture | TransitionEventHandler<HTMLLabelElement> | - | - |
| onTransitionStart | TransitionEventHandler<HTMLLabelElement> | - | - |
| onTransitionStartCapture | TransitionEventHandler<HTMLLabelElement> | - | - |
| onVolumeChange | ReactEventHandler<HTMLLabelElement> | - | - |
| onVolumeChangeCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onWaiting | ReactEventHandler<HTMLLabelElement> | - | - |
| onWaitingCapture | ReactEventHandler<HTMLLabelElement> | - | - |
| onWheel | WheelEventHandler<HTMLLabelElement> | - | - |
| onWheelCapture | WheelEventHandler<HTMLLabelElement> | - | - |
| part | string | - | @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part} |
| popover | "" | "auto" | "manual" | "hint" | - | - |
| popoverTarget | string | - | - |
| popoverTargetAction | "toggle" | "show" | "hide" | - | - |
| prefix | string | - | - |
| property | string | - | - |
| radioGroup | string | - | - |
| rel | string | - | - |
| render | DOMRenderFunction<"label", undefined> | - | 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. |
| resource | string | - | - |
| results | number | - | - |
| rev | string | - | - |
| role | AriaRole | - | - |
| security | string | - | - |
| slot | string | - | - |
| spellCheck | Booleanish | - | - |
| style | CSSProperties | - | - |
| suppressContentEditableWarning | boolean | - | - |
| suppressHydrationWarning | boolean | - | - |
| tabIndex | number | - | - |
| title | string | - | - |
| translate | "yes" | "no" | - | - |
| typeof | string | - | - |
| unselectable | "off" | "on" | - | - |
| vocab | string | - | - |
| Name | Type | Default | Description |
|---|---|---|---|
| about | string | - | - |
| accessKey | string | - | - |
| aria-activedescendant | string | - | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
| aria-atomic | Booleanish | - | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. |
| aria-autocomplete | "none" | "list" | "inline" | "both" | - | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. |
| aria-braillelabel | string | - | Defines a string value that labels the current element, which is intended to be converted into Braille. @see aria-label. |
| aria-brailleroledescription | string | - | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. @see aria-roledescription. |
| aria-busy | Booleanish | - | - |
| aria-checked | boolean | "true" | "false" | "mixed" | - | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. @see aria-pressed @see aria-selected. |
| aria-colcount | number | - | Defines the total number of columns in a table, grid, or treegrid. @see aria-colindex. |
| aria-colindex | number | - | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. @see aria-colcount @see aria-colspan. |
| aria-colindextext | string | - | Defines a human readable text alternative of aria-colindex. @see aria-rowindextext. |
| aria-colspan | number | - | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-colindex @see aria-rowspan. |
| aria-controls | string | - | Identifies the element (or elements) whose contents or presence are controlled by the current element. @see aria-owns. |
| aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | - | Indicates the element that 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-description | string | - | Defines a string value that describes or annotates the current element. @see related aria-describedby. |
| aria-details | string | - | Identifies the element (or elements) that provide a detailed, extended description for the object. |
| aria-disabled | Booleanish | - | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. @see aria-hidden @see aria-readonly. |
| aria-dropeffect | "none" | "link" | "copy" | "execute" | "move" | "popup" | - | Indicates what functions can be performed when a dragged object is released on the drop target. @deprecated in ARIA 1.1 |
| aria-errormessage | string | - | Identifies the element that provides an error message for the object. @see aria-invalid @see aria-describedby. |
| aria-expanded | Booleanish | - | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
| aria-flowto | string | - | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. |
| aria-grabbed | Booleanish | - | Indicates an element's "grabbed" state in a drag-and-drop operation. @deprecated in ARIA 1.1 |
| 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-hidden | Booleanish | - | Indicates whether the element is exposed to an accessibility API. @see aria-disabled. |
| aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | - | Indicates the entered value does not conform to the format expected by the application. @see aria-errormessage. |
| aria-keyshortcuts | string | - | Indicates keyboard shortcuts that an author has implemented to activate or give focus to 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-level | number | - | Defines the hierarchical level of an element within a structure. |
| aria-live | "off" | "assertive" | "polite" | - | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. |
| aria-modal | Booleanish | - | Indicates whether an element is modal when displayed. |
| aria-multiline | Booleanish | - | Indicates whether a text box accepts multiple lines of input or only a single line. |
| aria-multiselectable | Booleanish | - | Indicates that the user may select more than one item from the current selectable descendants. |
| aria-orientation | "horizontal" | "vertical" | - | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. |
| 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. @see aria-controls. |
| aria-placeholder | string | - | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. |
| aria-posinset | number | - | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-setsize. |
| aria-pressed | boolean | "true" | "false" | "mixed" | - | Indicates the current "pressed" state of toggle buttons. @see aria-checked @see aria-selected. |
| aria-readonly | Booleanish | - | Indicates that the element is not editable, but is otherwise operable. @see aria-disabled. |
| aria-relevant | "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | - | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. @see aria-atomic. |
| aria-required | Booleanish | - | Indicates that user input is required on the element before a form may be submitted. |
| aria-roledescription | string | - | Defines a human-readable, author-localized description for the role of an element. |
| aria-rowcount | number | - | Defines the total number of rows in a table, grid, or treegrid. @see aria-rowindex. |
| aria-rowindex | number | - | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. @see aria-rowcount @see aria-rowspan. |
| aria-rowindextext | string | - | Defines a human readable text alternative of aria-rowindex. @see aria-colindextext. |
| aria-rowspan | number | - | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-rowindex @see aria-colspan. |
| aria-selected | Booleanish | - | Indicates the current "selected" state of various widgets. @see aria-checked @see aria-pressed. |
| aria-setsize | number | - | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-posinset. |
| aria-sort | "none" | "ascending" | "descending" | "other" | - | Indicates if items in a table or grid are sorted in ascending or descending order. |
| aria-valuemax | number | - | Defines the maximum allowed value for a range widget. |
| aria-valuemin | number | - | Defines the minimum allowed value for a range widget. |
| aria-valuenow | number | - | Defines the current value for a range widget. @see aria-valuetext. |
| aria-valuetext | string | - | Defines the human readable text alternative of aria-valuenow for a range widget. |
| autoCapitalize | "off" | "none" | "on" | "sentences" | "words" | "characters" | (string & {}) | - | - |
| autoCorrect | string | - | - |
| autoFocus | boolean | - | - |
| autoSave | string | - | - |
| children | ChildrenOrFunction<GroupRenderProps> | - | The children of the component. A function may be provided to alter the children based on component state. |
| className | ClassNameOrFunction<GroupRenderProps> | 'react-aria-Group' | 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. |
| color | string | - | - |
| content | string | - | - |
| contentEditable | Booleanish | "inherit" | "plaintext-only" | - | - |
| contextMenu | string | - | - |
| dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | - | - |
| datatype | string | - | - |
| defaultChecked | boolean | - | - |
| defaultValue | string | number | readonly string[] | - | - |
| dir | string | - | - |
| draggable | Booleanish | - | - |
| enterKeyHint | "enter" | "done" | "go" | "next" | "previous" | "search" | "send" | - | - |
| exportparts | string | - | @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts} |
| hidden | boolean | - | - |
| id | string | - | - |
| inert | boolean | - | @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert |
| inlist | any | - | - |
| inputMode | "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | - | Hints at the type of data that might be entered by the user while editing the element or its contents @see {@link https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute} |
| is | string | - | Specify that a standard HTML element should behave like a defined custom built-in element @see {@link https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is} |
| isDisabled | boolean | - | Whether the group is disabled. |
| isInvalid | boolean | - | Whether the group is invalid. |
| isReadOnly | boolean | - | Whether the group is read only. |
| itemID | string | - | - |
| itemProp | string | - | - |
| itemRef | string | - | - |
| itemScope | boolean | - | - |
| itemType | string | - | - |
| lang | string | - | - |
| nonce | string | - | - |
| onAbort | ReactEventHandler<HTMLElement> | - | - |
| onAbortCapture | ReactEventHandler<HTMLElement> | - | - |
| onAnimationEnd | AnimationEventHandler<HTMLElement> | - | - |
| onAnimationEndCapture | AnimationEventHandler<HTMLElement> | - | - |
| onAnimationIteration | AnimationEventHandler<HTMLElement> | - | - |
| onAnimationIterationCapture | AnimationEventHandler<HTMLElement> | - | - |
| onAnimationStart | AnimationEventHandler<HTMLElement> | - | - |
| onAnimationStartCapture | AnimationEventHandler<HTMLElement> | - | - |
| onAuxClick | MouseEventHandler<HTMLElement> | - | - |
| onAuxClickCapture | MouseEventHandler<HTMLElement> | - | - |
| onBeforeInput | InputEventHandler<HTMLElement> | - | - |
| onBeforeInputCapture | FormEventHandler<HTMLElement> | - | - |
| onBeforeToggle | ToggleEventHandler<HTMLElement> | - | - |
| onBlur | FocusEventHandler<HTMLElement> | - | - |
| onBlurCapture | FocusEventHandler<HTMLElement> | - | - |
| onCanPlay | ReactEventHandler<HTMLElement> | - | - |
| onCanPlayCapture | ReactEventHandler<HTMLElement> | - | - |
| onCanPlayThrough | ReactEventHandler<HTMLElement> | - | - |
| onCanPlayThroughCapture | ReactEventHandler<HTMLElement> | - | - |
| onChange | FormEventHandler<HTMLElement> | - | - |
| onChangeCapture | FormEventHandler<HTMLElement> | - | - |
| onClick | MouseEventHandler<HTMLElement> | - | - |
| onClickCapture | MouseEventHandler<HTMLElement> | - | - |
| onCompositionEnd | CompositionEventHandler<HTMLElement> | - | - |
| onCompositionEndCapture | CompositionEventHandler<HTMLElement> | - | - |
| onCompositionStart | CompositionEventHandler<HTMLElement> | - | - |
| onCompositionStartCapture | CompositionEventHandler<HTMLElement> | - | - |
| onCompositionUpdate | CompositionEventHandler<HTMLElement> | - | - |
| onCompositionUpdateCapture | CompositionEventHandler<HTMLElement> | - | - |
| onContextMenu | MouseEventHandler<HTMLElement> | - | - |
| onContextMenuCapture | MouseEventHandler<HTMLElement> | - | - |
| onCopy | ClipboardEventHandler<HTMLElement> | - | - |
| onCopyCapture | ClipboardEventHandler<HTMLElement> | - | - |
| onCut | ClipboardEventHandler<HTMLElement> | - | - |
| onCutCapture | ClipboardEventHandler<HTMLElement> | - | - |
| onDoubleClick | MouseEventHandler<HTMLElement> | - | - |
| onDoubleClickCapture | MouseEventHandler<HTMLElement> | - | - |
| onDrag | DragEventHandler<HTMLElement> | - | - |
| onDragCapture | DragEventHandler<HTMLElement> | - | - |
| onDragEnd | DragEventHandler<HTMLElement> | - | - |
| onDragEndCapture | DragEventHandler<HTMLElement> | - | - |
| onDragEnter | DragEventHandler<HTMLElement> | - | - |
| onDragEnterCapture | DragEventHandler<HTMLElement> | - | - |
| onDragExit | DragEventHandler<HTMLElement> | - | - |
| onDragExitCapture | DragEventHandler<HTMLElement> | - | - |
| onDragLeave | DragEventHandler<HTMLElement> | - | - |
| onDragLeaveCapture | DragEventHandler<HTMLElement> | - | - |
| onDragOver | DragEventHandler<HTMLElement> | - | - |
| onDragOverCapture | DragEventHandler<HTMLElement> | - | - |
| onDragStart | DragEventHandler<HTMLElement> | - | - |
| onDragStartCapture | DragEventHandler<HTMLElement> | - | - |
| onDrop | DragEventHandler<HTMLElement> | - | - |
| onDropCapture | DragEventHandler<HTMLElement> | - | - |
| onDurationChange | ReactEventHandler<HTMLElement> | - | - |
| onDurationChangeCapture | ReactEventHandler<HTMLElement> | - | - |
| onEmptied | ReactEventHandler<HTMLElement> | - | - |
| onEmptiedCapture | ReactEventHandler<HTMLElement> | - | - |
| onEncrypted | ReactEventHandler<HTMLElement> | - | - |
| onEncryptedCapture | ReactEventHandler<HTMLElement> | - | - |
| onEnded | ReactEventHandler<HTMLElement> | - | - |
| onEndedCapture | ReactEventHandler<HTMLElement> | - | - |
| onError | ReactEventHandler<HTMLElement> | - | - |
| onErrorCapture | ReactEventHandler<HTMLElement> | - | - |
| onFocus | FocusEventHandler<HTMLElement> | - | - |
| onFocusCapture | FocusEventHandler<HTMLElement> | - | - |
| onGotPointerCapture | PointerEventHandler<HTMLElement> | - | - |
| onGotPointerCaptureCapture | PointerEventHandler<HTMLElement> | - | - |
| 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. |
| onInput | FormEventHandler<HTMLElement> | - | - |
| onInputCapture | FormEventHandler<HTMLElement> | - | - |
| onInvalid | FormEventHandler<HTMLElement> | - | - |
| onInvalidCapture | FormEventHandler<HTMLElement> | - | - |
| onKeyDown | KeyboardEventHandler<HTMLElement> | - | - |
| onKeyDownCapture | KeyboardEventHandler<HTMLElement> | - | - |
| onKeyPress | KeyboardEventHandler<HTMLElement> | - | @deprecated Use `onKeyUp` or `onKeyDown` instead |
| onKeyPressCapture | KeyboardEventHandler<HTMLElement> | - | @deprecated Use `onKeyUpCapture` or `onKeyDownCapture` instead |
| onKeyUp | KeyboardEventHandler<HTMLElement> | - | - |
| onKeyUpCapture | KeyboardEventHandler<HTMLElement> | - | - |
| onLoad | ReactEventHandler<HTMLElement> | - | - |
| onLoadCapture | ReactEventHandler<HTMLElement> | - | - |
| onLoadedData | ReactEventHandler<HTMLElement> | - | - |
| onLoadedDataCapture | ReactEventHandler<HTMLElement> | - | - |
| onLoadedMetadata | ReactEventHandler<HTMLElement> | - | - |
| onLoadedMetadataCapture | ReactEventHandler<HTMLElement> | - | - |
| onLoadStart | ReactEventHandler<HTMLElement> | - | - |
| onLoadStartCapture | ReactEventHandler<HTMLElement> | - | - |
| onLostPointerCapture | PointerEventHandler<HTMLElement> | - | - |
| onLostPointerCaptureCapture | PointerEventHandler<HTMLElement> | - | - |
| onMouseDown | MouseEventHandler<HTMLElement> | - | - |
| onMouseDownCapture | MouseEventHandler<HTMLElement> | - | - |
| onMouseEnter | MouseEventHandler<HTMLElement> | - | - |
| onMouseLeave | MouseEventHandler<HTMLElement> | - | - |
| onMouseMove | MouseEventHandler<HTMLElement> | - | - |
| onMouseMoveCapture | MouseEventHandler<HTMLElement> | - | - |
| onMouseOut | MouseEventHandler<HTMLElement> | - | - |
| onMouseOutCapture | MouseEventHandler<HTMLElement> | - | - |
| onMouseOver | MouseEventHandler<HTMLElement> | - | - |
| onMouseOverCapture | MouseEventHandler<HTMLElement> | - | - |
| onMouseUp | MouseEventHandler<HTMLElement> | - | - |
| onMouseUpCapture | MouseEventHandler<HTMLElement> | - | - |
| onPaste | ClipboardEventHandler<HTMLElement> | - | - |
| onPasteCapture | ClipboardEventHandler<HTMLElement> | - | - |
| onPause | ReactEventHandler<HTMLElement> | - | - |
| onPauseCapture | ReactEventHandler<HTMLElement> | - | - |
| onPlay | ReactEventHandler<HTMLElement> | - | - |
| onPlayCapture | ReactEventHandler<HTMLElement> | - | - |
| onPlaying | ReactEventHandler<HTMLElement> | - | - |
| onPlayingCapture | ReactEventHandler<HTMLElement> | - | - |
| onPointerCancel | PointerEventHandler<HTMLElement> | - | - |
| onPointerCancelCapture | PointerEventHandler<HTMLElement> | - | - |
| onPointerDown | PointerEventHandler<HTMLElement> | - | - |
| onPointerDownCapture | PointerEventHandler<HTMLElement> | - | - |
| onPointerEnter | PointerEventHandler<HTMLElement> | - | - |
| onPointerLeave | PointerEventHandler<HTMLElement> | - | - |
| onPointerMove | PointerEventHandler<HTMLElement> | - | - |
| onPointerMoveCapture | PointerEventHandler<HTMLElement> | - | - |
| onPointerOut | PointerEventHandler<HTMLElement> | - | - |
| onPointerOutCapture | PointerEventHandler<HTMLElement> | - | - |
| onPointerOver | PointerEventHandler<HTMLElement> | - | - |
| onPointerOverCapture | PointerEventHandler<HTMLElement> | - | - |
| onPointerUp | PointerEventHandler<HTMLElement> | - | - |
| onPointerUpCapture | PointerEventHandler<HTMLElement> | - | - |
| onProgress | ReactEventHandler<HTMLElement> | - | - |
| onProgressCapture | ReactEventHandler<HTMLElement> | - | - |
| onRateChange | ReactEventHandler<HTMLElement> | - | - |
| onRateChangeCapture | ReactEventHandler<HTMLElement> | - | - |
| onReset | FormEventHandler<HTMLElement> | - | - |
| onResetCapture | FormEventHandler<HTMLElement> | - | - |
| onScroll | UIEventHandler<HTMLElement> | - | - |
| onScrollCapture | UIEventHandler<HTMLElement> | - | - |
| onScrollEnd | UIEventHandler<HTMLElement> | - | - |
| onScrollEndCapture | UIEventHandler<HTMLElement> | - | - |
| onSeeked | ReactEventHandler<HTMLElement> | - | - |
| onSeekedCapture | ReactEventHandler<HTMLElement> | - | - |
| onSeeking | ReactEventHandler<HTMLElement> | - | - |
| onSeekingCapture | ReactEventHandler<HTMLElement> | - | - |
| onSelect | ReactEventHandler<HTMLElement> | - | - |
| onSelectCapture | ReactEventHandler<HTMLElement> | - | - |
| onStalled | ReactEventHandler<HTMLElement> | - | - |
| onStalledCapture | ReactEventHandler<HTMLElement> | - | - |
| onSubmit | FormEventHandler<HTMLElement> | - | - |
| onSubmitCapture | FormEventHandler<HTMLElement> | - | - |
| onSuspend | ReactEventHandler<HTMLElement> | - | - |
| onSuspendCapture | ReactEventHandler<HTMLElement> | - | - |
| onTimeUpdate | ReactEventHandler<HTMLElement> | - | - |
| onTimeUpdateCapture | ReactEventHandler<HTMLElement> | - | - |
| onToggle | ToggleEventHandler<HTMLElement> | - | - |
| onTouchCancel | TouchEventHandler<HTMLElement> | - | - |
| onTouchCancelCapture | TouchEventHandler<HTMLElement> | - | - |
| onTouchEnd | TouchEventHandler<HTMLElement> | - | - |
| onTouchEndCapture | TouchEventHandler<HTMLElement> | - | - |
| onTouchMove | TouchEventHandler<HTMLElement> | - | - |
| onTouchMoveCapture | TouchEventHandler<HTMLElement> | - | - |
| onTouchStart | TouchEventHandler<HTMLElement> | - | - |
| onTouchStartCapture | TouchEventHandler<HTMLElement> | - | - |
| onTransitionCancel | TransitionEventHandler<HTMLElement> | - | - |
| onTransitionCancelCapture | TransitionEventHandler<HTMLElement> | - | - |
| onTransitionEnd | TransitionEventHandler<HTMLElement> | - | - |
| onTransitionEndCapture | TransitionEventHandler<HTMLElement> | - | - |
| onTransitionRun | TransitionEventHandler<HTMLElement> | - | - |
| onTransitionRunCapture | TransitionEventHandler<HTMLElement> | - | - |
| onTransitionStart | TransitionEventHandler<HTMLElement> | - | - |
| onTransitionStartCapture | TransitionEventHandler<HTMLElement> | - | - |
| onVolumeChange | ReactEventHandler<HTMLElement> | - | - |
| onVolumeChangeCapture | ReactEventHandler<HTMLElement> | - | - |
| onWaiting | ReactEventHandler<HTMLElement> | - | - |
| onWaitingCapture | ReactEventHandler<HTMLElement> | - | - |
| onWheel | WheelEventHandler<HTMLElement> | - | - |
| onWheelCapture | WheelEventHandler<HTMLElement> | - | - |
| part | string | - | @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part} |
| popover | "" | "auto" | "manual" | "hint" | - | - |
| popoverTarget | string | - | - |
| popoverTargetAction | "toggle" | "show" | "hide" | - | - |
| prefix | string | - | - |
| property | string | - | - |
| radioGroup | string | - | - |
| rel | string | - | - |
| render | DOMRenderFunction<"div", GroupRenderProps> | - | 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. |
| resource | string | - | - |
| results | number | - | - |
| rev | string | - | - |
| role | "group" | "presentation" | "region" | 'group' | An accessibility role for the group. By default, this is set to `'group'`. Use `'region'` when the contents of the group is important enough to be included in the page table of contents. Use `'presentation'` if the group is visual only and does not represent a semantic grouping of controls. |
| security | string | - | - |
| 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. |
| spellCheck | Booleanish | - | - |
| style | StyleOrFunction<GroupRenderProps> | - | 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. |
| suppressContentEditableWarning | boolean | - | - |
| suppressHydrationWarning | boolean | - | - |
| tabIndex | number | - | - |
| title | string | - | - |
| translate | "yes" | "no" | - | - |
| typeof | string | - | - |
| unselectable | "off" | "on" | - | - |
| vocab | string | - | - |
| Name | Type | Default | Description |
|---|---|---|---|
| isInvalid | boolean | - | - |
| isSuccess | boolean | - | - |
| about | string | - | - |
| accessKey | string | - | - |
| aria-activedescendant | string | - | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
| aria-atomic | Booleanish | - | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. |
| aria-autocomplete | "none" | "list" | "inline" | "both" | - | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. |
| aria-braillelabel | string | - | Defines a string value that labels the current element, which is intended to be converted into Braille. @see aria-label. |
| aria-brailleroledescription | string | - | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. @see aria-roledescription. |
| aria-busy | Booleanish | - | - |
| aria-checked | boolean | "true" | "false" | "mixed" | - | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. @see aria-pressed @see aria-selected. |
| aria-colcount | number | - | Defines the total number of columns in a table, grid, or treegrid. @see aria-colindex. |
| aria-colindex | number | - | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. @see aria-colcount @see aria-colspan. |
| aria-colindextext | string | - | Defines a human readable text alternative of aria-colindex. @see aria-rowindextext. |
| aria-colspan | number | - | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-colindex @see aria-rowspan. |
| aria-controls | string | - | Identifies the element (or elements) whose contents or presence are controlled by the current element. @see aria-owns. |
| aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | - | Indicates the element that represents the current item within a container or set of related elements. |
| aria-describedby | string | - | Identifies the element (or elements) that describes the object. @see aria-labelledby |
| aria-description | string | - | Defines a string value that describes or annotates the current element. @see related aria-describedby. |
| aria-details | string | - | Identifies the element that provides a detailed, extended description for the object. @see aria-describedby. |
| aria-disabled | Booleanish | - | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. @see aria-hidden @see aria-readonly. |
| aria-dropeffect | "none" | "link" | "copy" | "execute" | "move" | "popup" | - | Indicates what functions can be performed when a dragged object is released on the drop target. @deprecated in ARIA 1.1 |
| aria-errormessage | string | - | Identifies the element that provides an error message for the object. @see aria-invalid @see aria-describedby. |
| aria-expanded | Booleanish | - | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
| aria-flowto | string | - | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. |
| aria-grabbed | Booleanish | - | Indicates an element's "grabbed" state in a drag-and-drop operation. @deprecated in ARIA 1.1 |
| 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-hidden | Booleanish | - | Indicates whether the element is exposed to an accessibility API. @see aria-disabled. |
| aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | - | Indicates the entered value does not conform to the format expected by the application. @see aria-errormessage. |
| aria-keyshortcuts | string | - | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
| aria-label | string | - | Defines a string value that labels the current element. @see aria-labelledby. |
| aria-labelledby | string | - | Identifies the element (or elements) that labels the current element. @see aria-describedby. |
| aria-level | number | - | Defines the hierarchical level of an element within a structure. |
| aria-live | "off" | "assertive" | "polite" | - | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. |
| aria-modal | Booleanish | - | Indicates whether an element is modal when displayed. |
| aria-multiline | Booleanish | - | Indicates whether a text box accepts multiple lines of input or only a single line. |
| aria-multiselectable | Booleanish | - | Indicates that the user may select more than one item from the current selectable descendants. |
| aria-orientation | "horizontal" | "vertical" | - | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. |
| 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. @see aria-controls. |
| aria-placeholder | string | - | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. |
| aria-posinset | number | - | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-setsize. |
| aria-pressed | boolean | "true" | "false" | "mixed" | - | Indicates the current "pressed" state of toggle buttons. @see aria-checked @see aria-selected. |
| aria-readonly | Booleanish | - | Indicates that the element is not editable, but is otherwise operable. @see aria-disabled. |
| aria-relevant | "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | - | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. @see aria-atomic. |
| aria-required | Booleanish | - | Indicates that user input is required on the element before a form may be submitted. |
| aria-roledescription | string | - | Defines a human-readable, author-localized description for the role of an element. |
| aria-rowcount | number | - | Defines the total number of rows in a table, grid, or treegrid. @see aria-rowindex. |
| aria-rowindex | number | - | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. @see aria-rowcount @see aria-rowspan. |
| aria-rowindextext | string | - | Defines a human readable text alternative of aria-rowindex. @see aria-colindextext. |
| aria-rowspan | number | - | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-rowindex @see aria-colspan. |
| aria-selected | Booleanish | - | Indicates the current "selected" state of various widgets. @see aria-checked @see aria-pressed. |
| aria-setsize | number | - | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. @see aria-posinset. |
| aria-sort | "none" | "ascending" | "descending" | "other" | - | Indicates if items in a table or grid are sorted in ascending or descending order. |
| aria-valuemax | number | - | Defines the maximum allowed value for a range widget. |
| aria-valuemin | number | - | Defines the minimum allowed value for a range widget. |
| aria-valuenow | number | - | Defines the current value for a range widget. @see aria-valuetext. |
| aria-valuetext | string | - | Defines the human readable text alternative of aria-valuenow for a range widget. |
| autoCapitalize | "off" | "none" | "on" | "sentences" | "words" | "characters" | (string & {}) | - | - |
| autoCorrect | string | - | - |
| autoFocus | boolean | - | - |
| autoSave | string | - | - |
| className | string | - | - |
| color | string | - | - |
| content | string | - | - |
| contentEditable | Booleanish | "inherit" | "plaintext-only" | - | - |
| contextMenu | string | - | - |
| dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | - | - |
| datatype | string | - | - |
| defaultChecked | boolean | - | - |
| defaultValue | string | number | readonly string[] | - | - |
| dir | string | - | - |
| draggable | Booleanish | - | - |
| elementType | string | - | - |
| enterKeyHint | "enter" | "done" | "go" | "next" | "previous" | "search" | "send" | - | - |
| exportparts | string | - | @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts} |
| hidden | boolean | - | - |
| id | string | - | - |
| inert | boolean | - | @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert |
| inlist | any | - | - |
| inputMode | "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | - | Hints at the type of data that might be entered by the user while editing the element or its contents @see {@link https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute} |
| is | string | - | Specify that a standard HTML element should behave like a defined custom built-in element @see {@link https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is} |
| itemID | string | - | - |
| itemProp | string | - | - |
| itemRef | string | - | - |
| itemScope | boolean | - | - |
| itemType | string | - | - |
| lang | string | - | - |
| nonce | string | - | - |
| onAbort | ReactEventHandler<HTMLElement> | - | - |
| onAbortCapture | ReactEventHandler<HTMLElement> | - | - |
| onAnimationEnd | AnimationEventHandler<HTMLElement> | - | - |
| onAnimationEndCapture | AnimationEventHandler<HTMLElement> | - | - |
| onAnimationIteration | AnimationEventHandler<HTMLElement> | - | - |
| onAnimationIterationCapture | AnimationEventHandler<HTMLElement> | - | - |
| onAnimationStart | AnimationEventHandler<HTMLElement> | - | - |
| onAnimationStartCapture | AnimationEventHandler<HTMLElement> | - | - |
| onAuxClick | MouseEventHandler<HTMLElement> | - | - |
| onAuxClickCapture | MouseEventHandler<HTMLElement> | - | - |
| onBeforeInput | InputEventHandler<HTMLElement> | - | - |
| onBeforeInputCapture | FormEventHandler<HTMLElement> | - | - |
| onBeforeToggle | ToggleEventHandler<HTMLElement> | - | - |
| onBlur | FocusEventHandler<HTMLElement> | - | - |
| onBlurCapture | FocusEventHandler<HTMLElement> | - | - |
| onCanPlay | ReactEventHandler<HTMLElement> | - | - |
| onCanPlayCapture | ReactEventHandler<HTMLElement> | - | - |
| onCanPlayThrough | ReactEventHandler<HTMLElement> | - | - |
| onCanPlayThroughCapture | ReactEventHandler<HTMLElement> | - | - |
| onChange | FormEventHandler<HTMLElement> | - | - |
| onChangeCapture | FormEventHandler<HTMLElement> | - | - |
| onClick | MouseEventHandler<HTMLElement> | - | - |
| onClickCapture | MouseEventHandler<HTMLElement> | - | - |
| onCompositionEnd | CompositionEventHandler<HTMLElement> | - | - |
| onCompositionEndCapture | CompositionEventHandler<HTMLElement> | - | - |
| onCompositionStart | CompositionEventHandler<HTMLElement> | - | - |
| onCompositionStartCapture | CompositionEventHandler<HTMLElement> | - | - |
| onCompositionUpdate | CompositionEventHandler<HTMLElement> | - | - |
| onCompositionUpdateCapture | CompositionEventHandler<HTMLElement> | - | - |
| onContextMenu | MouseEventHandler<HTMLElement> | - | - |
| onContextMenuCapture | MouseEventHandler<HTMLElement> | - | - |
| onCopy | ClipboardEventHandler<HTMLElement> | - | - |
| onCopyCapture | ClipboardEventHandler<HTMLElement> | - | - |
| onCut | ClipboardEventHandler<HTMLElement> | - | - |
| onCutCapture | ClipboardEventHandler<HTMLElement> | - | - |
| onDoubleClick | MouseEventHandler<HTMLElement> | - | - |
| onDoubleClickCapture | MouseEventHandler<HTMLElement> | - | - |
| onDrag | DragEventHandler<HTMLElement> | - | - |
| onDragCapture | DragEventHandler<HTMLElement> | - | - |
| onDragEnd | DragEventHandler<HTMLElement> | - | - |
| onDragEndCapture | DragEventHandler<HTMLElement> | - | - |
| onDragEnter | DragEventHandler<HTMLElement> | - | - |
| onDragEnterCapture | DragEventHandler<HTMLElement> | - | - |
| onDragExit | DragEventHandler<HTMLElement> | - | - |
| onDragExitCapture | DragEventHandler<HTMLElement> | - | - |
| onDragLeave | DragEventHandler<HTMLElement> | - | - |
| onDragLeaveCapture | DragEventHandler<HTMLElement> | - | - |
| onDragOver | DragEventHandler<HTMLElement> | - | - |
| onDragOverCapture | DragEventHandler<HTMLElement> | - | - |
| onDragStart | DragEventHandler<HTMLElement> | - | - |
| onDragStartCapture | DragEventHandler<HTMLElement> | - | - |
| onDrop | DragEventHandler<HTMLElement> | - | - |
| onDropCapture | DragEventHandler<HTMLElement> | - | - |
| onDurationChange | ReactEventHandler<HTMLElement> | - | - |
| onDurationChangeCapture | ReactEventHandler<HTMLElement> | - | - |
| onEmptied | ReactEventHandler<HTMLElement> | - | - |
| onEmptiedCapture | ReactEventHandler<HTMLElement> | - | - |
| onEncrypted | ReactEventHandler<HTMLElement> | - | - |
| onEncryptedCapture | ReactEventHandler<HTMLElement> | - | - |
| onEnded | ReactEventHandler<HTMLElement> | - | - |
| onEndedCapture | ReactEventHandler<HTMLElement> | - | - |
| onError | ReactEventHandler<HTMLElement> | - | - |
| onErrorCapture | ReactEventHandler<HTMLElement> | - | - |
| onFocus | FocusEventHandler<HTMLElement> | - | - |
| onFocusCapture | FocusEventHandler<HTMLElement> | - | - |
| onGotPointerCapture | PointerEventHandler<HTMLElement> | - | - |
| onGotPointerCaptureCapture | PointerEventHandler<HTMLElement> | - | - |
| onInput | FormEventHandler<HTMLElement> | - | - |
| onInputCapture | FormEventHandler<HTMLElement> | - | - |
| onInvalid | FormEventHandler<HTMLElement> | - | - |
| onInvalidCapture | FormEventHandler<HTMLElement> | - | - |
| onKeyDown | KeyboardEventHandler<HTMLElement> | - | - |
| onKeyDownCapture | KeyboardEventHandler<HTMLElement> | - | - |
| onKeyPress | KeyboardEventHandler<HTMLElement> | - | @deprecated Use `onKeyUp` or `onKeyDown` instead |
| onKeyPressCapture | KeyboardEventHandler<HTMLElement> | - | @deprecated Use `onKeyUpCapture` or `onKeyDownCapture` instead |
| onKeyUp | KeyboardEventHandler<HTMLElement> | - | - |
| onKeyUpCapture | KeyboardEventHandler<HTMLElement> | - | - |
| onLoad | ReactEventHandler<HTMLElement> | - | - |
| onLoadCapture | ReactEventHandler<HTMLElement> | - | - |
| onLoadedData | ReactEventHandler<HTMLElement> | - | - |
| onLoadedDataCapture | ReactEventHandler<HTMLElement> | - | - |
| onLoadedMetadata | ReactEventHandler<HTMLElement> | - | - |
| onLoadedMetadataCapture | ReactEventHandler<HTMLElement> | - | - |
| onLoadStart | ReactEventHandler<HTMLElement> | - | - |
| onLoadStartCapture | ReactEventHandler<HTMLElement> | - | - |
| onLostPointerCapture | PointerEventHandler<HTMLElement> | - | - |
| onLostPointerCaptureCapture | PointerEventHandler<HTMLElement> | - | - |
| onMouseDown | MouseEventHandler<HTMLElement> | - | - |
| onMouseDownCapture | MouseEventHandler<HTMLElement> | - | - |
| onMouseEnter | MouseEventHandler<HTMLElement> | - | - |
| onMouseLeave | MouseEventHandler<HTMLElement> | - | - |
| onMouseMove | MouseEventHandler<HTMLElement> | - | - |
| onMouseMoveCapture | MouseEventHandler<HTMLElement> | - | - |
| onMouseOut | MouseEventHandler<HTMLElement> | - | - |
| onMouseOutCapture | MouseEventHandler<HTMLElement> | - | - |
| onMouseOver | MouseEventHandler<HTMLElement> | - | - |
| onMouseOverCapture | MouseEventHandler<HTMLElement> | - | - |
| onMouseUp | MouseEventHandler<HTMLElement> | - | - |
| onMouseUpCapture | MouseEventHandler<HTMLElement> | - | - |
| onPaste | ClipboardEventHandler<HTMLElement> | - | - |
| onPasteCapture | ClipboardEventHandler<HTMLElement> | - | - |
| onPause | ReactEventHandler<HTMLElement> | - | - |
| onPauseCapture | ReactEventHandler<HTMLElement> | - | - |
| onPlay | ReactEventHandler<HTMLElement> | - | - |
| onPlayCapture | ReactEventHandler<HTMLElement> | - | - |
| onPlaying | ReactEventHandler<HTMLElement> | - | - |
| onPlayingCapture | ReactEventHandler<HTMLElement> | - | - |
| onPointerCancel | PointerEventHandler<HTMLElement> | - | - |
| onPointerCancelCapture | PointerEventHandler<HTMLElement> | - | - |
| onPointerDown | PointerEventHandler<HTMLElement> | - | - |
| onPointerDownCapture | PointerEventHandler<HTMLElement> | - | - |
| onPointerEnter | PointerEventHandler<HTMLElement> | - | - |
| onPointerLeave | PointerEventHandler<HTMLElement> | - | - |
| onPointerMove | PointerEventHandler<HTMLElement> | - | - |
| onPointerMoveCapture | PointerEventHandler<HTMLElement> | - | - |
| onPointerOut | PointerEventHandler<HTMLElement> | - | - |
| onPointerOutCapture | PointerEventHandler<HTMLElement> | - | - |
| onPointerOver | PointerEventHandler<HTMLElement> | - | - |
| onPointerOverCapture | PointerEventHandler<HTMLElement> | - | - |
| onPointerUp | PointerEventHandler<HTMLElement> | - | - |
| onPointerUpCapture | PointerEventHandler<HTMLElement> | - | - |
| onProgress | ReactEventHandler<HTMLElement> | - | - |
| onProgressCapture | ReactEventHandler<HTMLElement> | - | - |
| onRateChange | ReactEventHandler<HTMLElement> | - | - |
| onRateChangeCapture | ReactEventHandler<HTMLElement> | - | - |
| onReset | FormEventHandler<HTMLElement> | - | - |
| onResetCapture | FormEventHandler<HTMLElement> | - | - |
| onScroll | UIEventHandler<HTMLElement> | - | - |
| onScrollCapture | UIEventHandler<HTMLElement> | - | - |
| onScrollEnd | UIEventHandler<HTMLElement> | - | - |
| onScrollEndCapture | UIEventHandler<HTMLElement> | - | - |
| onSeeked | ReactEventHandler<HTMLElement> | - | - |
| onSeekedCapture | ReactEventHandler<HTMLElement> | - | - |
| onSeeking | ReactEventHandler<HTMLElement> | - | - |
| onSeekingCapture | ReactEventHandler<HTMLElement> | - | - |
| onSelect | ReactEventHandler<HTMLElement> | - | - |
| onSelectCapture | ReactEventHandler<HTMLElement> | - | - |
| onStalled | ReactEventHandler<HTMLElement> | - | - |
| onStalledCapture | ReactEventHandler<HTMLElement> | - | - |
| onSubmit | FormEventHandler<HTMLElement> | - | - |
| onSubmitCapture | FormEventHandler<HTMLElement> | - | - |
| onSuspend | ReactEventHandler<HTMLElement> | - | - |
| onSuspendCapture | ReactEventHandler<HTMLElement> | - | - |
| onTimeUpdate | ReactEventHandler<HTMLElement> | - | - |
| onTimeUpdateCapture | ReactEventHandler<HTMLElement> | - | - |
| onToggle | ToggleEventHandler<HTMLElement> | - | - |
| onTouchCancel | TouchEventHandler<HTMLElement> | - | - |
| onTouchCancelCapture | TouchEventHandler<HTMLElement> | - | - |
| onTouchEnd | TouchEventHandler<HTMLElement> | - | - |
| onTouchEndCapture | TouchEventHandler<HTMLElement> | - | - |
| onTouchMove | TouchEventHandler<HTMLElement> | - | - |
| onTouchMoveCapture | TouchEventHandler<HTMLElement> | - | - |
| onTouchStart | TouchEventHandler<HTMLElement> | - | - |
| onTouchStartCapture | TouchEventHandler<HTMLElement> | - | - |
| onTransitionCancel | TransitionEventHandler<HTMLElement> | - | - |
| onTransitionCancelCapture | TransitionEventHandler<HTMLElement> | - | - |
| onTransitionEnd | TransitionEventHandler<HTMLElement> | - | - |
| onTransitionEndCapture | TransitionEventHandler<HTMLElement> | - | - |
| onTransitionRun | TransitionEventHandler<HTMLElement> | - | - |
| onTransitionRunCapture | TransitionEventHandler<HTMLElement> | - | - |
| onTransitionStart | TransitionEventHandler<HTMLElement> | - | - |
| onTransitionStartCapture | TransitionEventHandler<HTMLElement> | - | - |
| onVolumeChange | ReactEventHandler<HTMLElement> | - | - |
| onVolumeChangeCapture | ReactEventHandler<HTMLElement> | - | - |
| onWaiting | ReactEventHandler<HTMLElement> | - | - |
| onWaitingCapture | ReactEventHandler<HTMLElement> | - | - |
| onWheel | WheelEventHandler<HTMLElement> | - | - |
| onWheelCapture | WheelEventHandler<HTMLElement> | - | - |
| part | string | - | @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part} |
| popover | "" | "auto" | "manual" | "hint" | - | - |
| popoverTarget | string | - | - |
| popoverTargetAction | "toggle" | "show" | "hide" | - | - |
| prefix | string | - | - |
| property | string | - | - |
| radioGroup | string | - | - |
| rel | string | - | - |
| render | DOMRenderFunction<any, any> | - | 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. |
| resource | string | - | - |
| results | number | - | - |
| rev | string | - | - |
| role | AriaRole | - | - |
| security | string | - | - |
| slot | string | - | - |
| spellCheck | Booleanish | - | - |
| style | CSSProperties | - | - |
| suppressContentEditableWarning | boolean | - | - |
| suppressHydrationWarning | boolean | - | - |
| tabIndex | number | - | - |
| title | string | - | - |
| translate | "yes" | "no" | - | - |
| typeof | string | - | - |
| unselectable | "off" | "on" | - | - |
| vocab | string | - | - |
| Name | Type | Default | Description |
|---|---|---|---|
| children | ChildrenOrFunction<FieldErrorRenderProps> | - | The children of the component. A function may be provided to alter the children based on component state. |
| className | ClassNameOrFunction<FieldErrorRenderProps> | 'react-aria-FieldError' | 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 | - | - |
| 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 | - | - |
| 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> | - | - |
| render | DOMRenderFunction<"div", FieldErrorRenderProps> | - | 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. |
| style | StyleOrFunction<FieldErrorRenderProps> | - | 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 |
|---|---|---|---|
| placement | Placements | - | The placement of the element with respect to its anchor 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. |
| 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. |
| arrowBoundaryOffset | number | 0 | The minimum distance the arrow's edge should be from the edge of the overlay element. |
| arrowRef | RefObject<Element> | - | A ref for the popover arrow element. |
| boundaryElement | Element | document.body | Element that that serves as the positioning boundary. |
| className | ClassNameOrFunction<PopoverRenderProps> | 'react-aria-Popover' | 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. |
| containerPadding | number | 12 | The placement padding that should be applied between the element and its surrounding container. |
| crossOffset | number | 0 | The additional offset applied along the cross axis between the element and its anchor element. |
| defaultOpen | boolean | - | Whether the overlay is open by default (uncontrolled). |
| dir | string | - | - |
| hidden | boolean | - | - |
| inert | boolean | - | - |
| isEntering | boolean | - | Whether the popover is currently performing an entry animation. |
| isExiting | boolean | - | Whether the popover is currently performing an exit animation. |
| isKeyboardDismissDisabled | boolean | false | Whether pressing the escape key to close the popover should be disabled. Most popovers should not use this option. When set to true, an alternative way to close the popover with a keyboard must be provided. |
| isNonModal | boolean | - | Whether the popover is non-modal, i.e. elements outside the popover may be interacted with by assistive technologies. Most popovers should not use this option as it may negatively impact the screen reader experience. Only use with components such as combobox, which are designed to handle this situation carefully. |
| isOpen | boolean | - | Whether the overlay is open by default (controlled). |
| lang | string | - | - |
| maxHeight | number | - | The maxHeight specified for the overlay element. By default, it will take all space up to the current viewport height. |
| offset | number | 8 | The additional offset applied along the main axis between the element and its anchor element. |
| 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", PopoverRenderProps> | - | 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. |
| scrollRef | RefObject<Element> | overlayRef | A ref for the scrollable region within the overlay. |
| shouldFlip | boolean | true | Whether the element should flip its orientation (e.g. top to bottom or left to right) when there is insufficient room for it to render completely. |
| shouldUpdatePosition | boolean | true | Whether the overlay should update its position automatically. |
| 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<PopoverRenderProps> | - | 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" | - | - |
| trigger | string | - | The name of the component that triggered the popover. This is reflected on the element as the `data-trigger` attribute, and can be used to provide specific styles for the popover depending on which element triggered it. |
| triggerRef | RefObject<Element> | - | The ref for the element which the popover positions itself with respect to. When used within a trigger component such as DialogTrigger, MenuTrigger, Select, etc., this is set automatically. It is only required when used standalone. |
| Name | Type | Default | Description |
|---|---|---|---|
| isDateHighlighted | (date: T) => boolean | - | - |
| allowsNonContiguousRanges | boolean | - | When combined with `isDateUnavailable`, determines whether non-contiguous ranges, i.e. ranges containing unavailable dates, may be selected. |
| firstDayOfWeek | "sun" | "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | - | The day that starts the week. |
| pageBehavior | PageBehavior | visible | Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration. |
| visibleDuration | DateDuration | {months: 1} | The amount of days that will be displayed at once. This affects how pagination works. |