ComboBox
Props
API reference for ComboBox. For usage examples, see the React tab.
Combobox.Root
| Name | Type | Default |
|---|---|---|
| allowsCustomValue | boolean | — |
Whether the ComboBox allows a non-item matching input value to be set. | ||
| allowsEmptyCollection | boolean | — |
Whether the combo box allows the menu to be open when the collection is empty. | ||
| children | ChildrenOrFunction<ComboBoxRenderProps> | — |
The children of the component. A function may be provided to alter the children based on component state. | ||
| defaultFilter | ((textValue: string, inputValue: string) => boolean) | — |
The filter function used to determine if an option should be included in the combo box list. By default, a language-sensitive "contains" filter from | ||
| defaultItems | Iterable<T> | — |
The list of ComboBox items (uncontrolled). | ||
| disabledKeys | Iterable<Key> | — |
The item keys that are disabled. These items cannot be selected, focused, or otherwise interacted with. | ||
| disableIconAnimation | boolean | — |
| formValue | "key" | "text" | 'key' |
Whether the text or key of the selected item is submitted as part of an HTML form. When | ||
| iconVariant | "chevron" | "search" | chevron |
| isDisabled | boolean | — |
Whether the input is disabled. | ||
| isInvalid | boolean | — |
Whether the input value is invalid. | ||
| isReadOnly | boolean | — |
Whether the input can be selected but not changed by the user. | ||
| isRequired | boolean | — |
Whether user input is required on the input before form submission. | ||
| items | Iterable<T> | — |
The list of ComboBox items (controlled). | ||
| menuTrigger | MenuTriggerAction | 'input' |
The interaction required to display the ComboBox menu. | ||
| selectionMode | "multiple" | "single" | 'single' |
Whether single or multiple selection is enabled. | ||
| 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. | ||
| shouldFocusWrap | boolean | — |
Whether keyboard navigation is circular. | ||
| size | "lg" | "md" | "sm" | md |
Controls height, padding, and typography of the input. | ||
| compactDeprecated | boolean | — |
Use | ||
| Name | Type | Default |
|---|---|---|
| aria-describedby | string | — |
Identifies the element (or elements) that describes the object. | ||
| aria-details | string | — |
Identifies the element (or elements) that provide a detailed, extended description for the object. | ||
| aria-label | string | — |
Defines a string value that labels the current element. | ||
| aria-labelledby | string | — |
Identifies the element (or elements) that labels the current element. | ||
| id | string | — |
The element's unique identifier. See MDN (opens in new tab). | ||
| Name | Type | Default |
|---|---|---|
| autoFocus | boolean | — |
Whether the element should receive focus on render. | ||
| dir | string | — |
| hidden | boolean | — |
| inert | boolean | — |
| lang | string | — |
| ref | Ref<HTMLDivElement> | — |
Requires React 19 | ||
| render | DOMRenderFunction<"div", ComboBoxRenderProps> | — |
Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements:
| ||
| slot | string | null | — |
A slot name for the component. Slots allow the component to receive props from a parent component. An explicit | ||
| suppressHydrationWarning | boolean | — |
A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs (opens in new tab). | ||
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationStart | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAuxClick | MouseEventHandler<HTMLDivElement> | — |
| onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onBlur | ((e: FocusEvent<HTMLInputElement, Element>) => void) | — |
Handler that is called when the element loses focus. | ||
| onChange | ((value: ChangeValueType<M>) => 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<HTMLInputElement, 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> | — |
| onInputChange | ((value: string) => void) | — |
Handler that is called when the ComboBox input value changes. | ||
| onKeyDown | ((e: KeyboardEvent) => void) | — |
Handler that is called when a key is pressed. | ||
| onKeyUp | ((e: KeyboardEvent) => void) | — |
Handler that is called when a key is released. | ||
| 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, menuTrigger?: MenuTriggerAction) => void) | — |
Method that is called when the open state of the menu changes. Returns the new open state and the action that caused the opening of the menu. | ||
| onPointerCancel | PointerEventHandler<HTMLDivElement> | — |
| onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerDown | PointerEventHandler<HTMLDivElement> | — |
| onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerEnter | PointerEventHandler<HTMLDivElement> | — |
| onPointerLeave | PointerEventHandler<HTMLDivElement> | — |
| onPointerMove | PointerEventHandler<HTMLDivElement> | — |
| onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerOut | PointerEventHandler<HTMLDivElement> | — |
| onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerOver | PointerEventHandler<HTMLDivElement> | — |
| onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerUp | PointerEventHandler<HTMLDivElement> | — |
| onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — |
| onScroll | UIEventHandler<HTMLDivElement> | — |
| onScrollCapture | UIEventHandler<HTMLDivElement> | — |
| onTouchCancel | TouchEventHandler<HTMLDivElement> | — |
| onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchEnd | TouchEventHandler<HTMLDivElement> | — |
| onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchMove | TouchEventHandler<HTMLDivElement> | — |
| onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchStart | TouchEventHandler<HTMLDivElement> | — |
| onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — |
| onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionRun | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionStart | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — |
| onWheel | WheelEventHandler<HTMLDivElement> | — |
| onWheelCapture | WheelEventHandler<HTMLDivElement> | — |
| Name | Type | Default |
|---|---|---|
| defaultInputValue | string | — |
The default value of the ComboBox input (uncontrolled). | ||
| defaultValue | readonly Key[] | Key | null | — |
The default value (uncontrolled). | ||
| form | string | — |
The | ||
| inputValue | string | — |
The value of the ComboBox input (controlled). | ||
| name | string | — |
The name of the input element, used when submitting an HTML form. See MDN (opens in new tab). | ||
| validate | ((value: ComboBoxValidationValue<M>) => true | ValidationError | null) | — |
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 | "aria" | "native" | '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 | readonly Key[] | Key | null | — |
The current value (controlled). | ||
| Name | Type | Default |
|---|---|---|
| className | ClassNameOrFunction<ComboBoxRenderProps> | 'react-aria-ComboBox' |
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state. | ||
| style | StyleOrFunction<ComboBoxRenderProps> | — |
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state. | ||
Combobox.Button
| Name | Type | Default |
|---|---|---|
| children | ChildrenOrFunction<ButtonRenderProps> | — |
The children of the component. A function may be provided to alter the children based on component state. | ||
| disableIconAnimation | boolean | — |
| iconVariant | "chevron" | "search" | — |
| isDisabled | boolean | — |
Whether the button is disabled. | ||
| isPending | boolean | — |
Whether the button is in a pending state. This disables press and hover events while retaining focusability, and announces the pending state to screen readers. | ||
| Name | Type | Default |
|---|---|---|
| aria-controls | string | — |
Identifies the element (or elements) whose contents or presence are controlled by the current element. | ||
| aria-current | "date" | "false" | "location" | "page" | "step" | "time" | "true" | boolean | — |
Indicates whether this element represents the current item within a container or set of related elements. | ||
| aria-describedby | string | — |
Identifies the element (or elements) that describes the object. | ||
| aria-details | string | — |
Identifies the element (or elements) that provide a detailed, extended description for the object. | ||
| aria-disabled | "false" | "true" | boolean | — |
Indicates whether the element is disabled to users of assistive technology. | ||
| aria-expanded | "false" | "true" | boolean | — |
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. | ||
| aria-haspopup | "dialog" | "false" | "grid" | "listbox" | "menu" | "tree" | "true" | boolean | — |
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | ||
| aria-label | string | — |
Defines a string value that labels the current element. | ||
| aria-labelledby | string | — |
Identifies the element (or elements) that labels the current element. | ||
| aria-pressed | "false" | "mixed" | "true" | boolean | — |
Indicates the current "pressed" state of toggle buttons. | ||
| id | string | — |
The element's unique identifier. See MDN (opens in new tab). | ||
| Name | Type | Default |
|---|---|---|
| autoFocus | boolean | — |
Whether the element should receive focus on render. | ||
| dir | string | — |
| excludeFromTabOrder | boolean | — |
Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available. | ||
| hidden | boolean | — |
| inert | boolean | — |
| lang | string | — |
| preventFocusOnPress | boolean | — |
Whether to prevent focus from moving to the button when pressing it. Caution, this can make the button inaccessible and should only be used when alternative keyboard interaction is provided, such as ComboBox's MenuTrigger or a NumberField's increment/decrement control. | ||
| ref | Ref<HTMLButtonElement> | — |
Requires React 19 | ||
| render | DOMRenderFunction<"button", ButtonRenderProps> | — |
Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements:
| ||
| slot | string | null | — |
A slot name for the component. Slots allow the component to receive props from a parent component. An explicit | ||
| suppressHydrationWarning | boolean | — |
A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs (opens in new tab). | ||
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| onAnimationEnd | AnimationEventHandler<HTMLButtonElement> | — |
| onAnimationEndCapture | AnimationEventHandler<HTMLButtonElement> | — |
| onAnimationIteration | AnimationEventHandler<HTMLButtonElement> | — |
| onAnimationIterationCapture | AnimationEventHandler<HTMLButtonElement> | — |
| onAnimationStart | AnimationEventHandler<HTMLButtonElement> | — |
| onAnimationStartCapture | AnimationEventHandler<HTMLButtonElement> | — |
| onAuxClick | MouseEventHandler<HTMLButtonElement> | — |
| onAuxClickCapture | MouseEventHandler<HTMLButtonElement> | — |
| onBlur | ((e: FocusEvent<Element, Element>) => void) | — |
Handler that is called when the element loses focus. | ||
| onClickCapture | MouseEventHandler<HTMLButtonElement> | — |
| onContextMenu | MouseEventHandler<HTMLButtonElement> | — |
| onContextMenuCapture | MouseEventHandler<HTMLButtonElement> | — |
| onDoubleClick | MouseEventHandler<HTMLButtonElement> | — |
| onDoubleClickCapture | MouseEventHandler<HTMLButtonElement> | — |
| onFocus | ((e: FocusEvent<Element, Element>) => void) | — |
Handler that is called when the element receives focus. | ||
| onFocusChange | ((isFocused: boolean) => void) | — |
Handler that is called when the element's focus status changes. | ||
| onGotPointerCapture | PointerEventHandler<HTMLButtonElement> | — |
| onGotPointerCaptureCapture | PointerEventHandler<HTMLButtonElement> | — |
| onHoverChange | ((isHovering: boolean) => void) | — |
Handler that is called when the hover state changes. | ||
| onHoverEnd | ((e: HoverEvent) => void) | — |
Handler that is called when a hover interaction ends. | ||
| onHoverStart | ((e: HoverEvent) => void) | — |
Handler that is called when a hover interaction starts. | ||
| onKeyDown | ((e: KeyboardEvent) => void) | — |
Handler that is called when a key is pressed. | ||
| onKeyUp | ((e: KeyboardEvent) => void) | — |
Handler that is called when a key is released. | ||
| onLostPointerCapture | PointerEventHandler<HTMLButtonElement> | — |
| onLostPointerCaptureCapture | PointerEventHandler<HTMLButtonElement> | — |
| onMouseDown | MouseEventHandler<HTMLButtonElement> | — |
| onMouseDownCapture | MouseEventHandler<HTMLButtonElement> | — |
| onMouseEnter | MouseEventHandler<HTMLButtonElement> | — |
| onMouseLeave | MouseEventHandler<HTMLButtonElement> | — |
| onMouseMove | MouseEventHandler<HTMLButtonElement> | — |
| onMouseMoveCapture | MouseEventHandler<HTMLButtonElement> | — |
| onMouseOut | MouseEventHandler<HTMLButtonElement> | — |
| onMouseOutCapture | MouseEventHandler<HTMLButtonElement> | — |
| onMouseOver | MouseEventHandler<HTMLButtonElement> | — |
| onMouseOverCapture | MouseEventHandler<HTMLButtonElement> | — |
| onMouseUp | MouseEventHandler<HTMLButtonElement> | — |
| onMouseUpCapture | MouseEventHandler<HTMLButtonElement> | — |
| onPointerCancel | PointerEventHandler<HTMLButtonElement> | — |
| onPointerCancelCapture | PointerEventHandler<HTMLButtonElement> | — |
| onPointerDown | PointerEventHandler<HTMLButtonElement> | — |
| onPointerDownCapture | PointerEventHandler<HTMLButtonElement> | — |
| onPointerEnter | PointerEventHandler<HTMLButtonElement> | — |
| onPointerLeave | PointerEventHandler<HTMLButtonElement> | — |
| onPointerMove | PointerEventHandler<HTMLButtonElement> | — |
| onPointerMoveCapture | PointerEventHandler<HTMLButtonElement> | — |
| onPointerOut | PointerEventHandler<HTMLButtonElement> | — |
| onPointerOutCapture | PointerEventHandler<HTMLButtonElement> | — |
| onPointerOver | PointerEventHandler<HTMLButtonElement> | — |
| onPointerOverCapture | PointerEventHandler<HTMLButtonElement> | — |
| onPointerUp | PointerEventHandler<HTMLButtonElement> | — |
| onPointerUpCapture | PointerEventHandler<HTMLButtonElement> | — |
| onPress | ((e: PressEvent) => void) | — |
Handler that is called when the press is released over the target. | ||
| onPressChange | ((isPressed: boolean) => void) | — |
Handler that is called when the press state changes. | ||
| onPressEnd | ((e: PressEvent) => void) | — |
Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target. | ||
| onPressStart | ((e: PressEvent) => void) | — |
Handler that is called when a press interaction starts. | ||
| onPressUp | ((e: PressEvent) => void) | — |
Handler that is called when a press is released over the target, regardless of whether it started on the target or not. | ||
| onScroll | UIEventHandler<HTMLButtonElement> | — |
| onScrollCapture | UIEventHandler<HTMLButtonElement> | — |
| onTouchCancel | TouchEventHandler<HTMLButtonElement> | — |
| onTouchCancelCapture | TouchEventHandler<HTMLButtonElement> | — |
| onTouchEnd | TouchEventHandler<HTMLButtonElement> | — |
| onTouchEndCapture | TouchEventHandler<HTMLButtonElement> | — |
| onTouchMove | TouchEventHandler<HTMLButtonElement> | — |
| onTouchMoveCapture | TouchEventHandler<HTMLButtonElement> | — |
| onTouchStart | TouchEventHandler<HTMLButtonElement> | — |
| onTouchStartCapture | TouchEventHandler<HTMLButtonElement> | — |
| onTransitionCancel | TransitionEventHandler<HTMLButtonElement> | — |
| onTransitionCancelCapture | TransitionEventHandler<HTMLButtonElement> | — |
| onTransitionEnd | TransitionEventHandler<HTMLButtonElement> | — |
| onTransitionEndCapture | TransitionEventHandler<HTMLButtonElement> | — |
| onTransitionRun | TransitionEventHandler<HTMLButtonElement> | — |
| onTransitionRunCapture | TransitionEventHandler<HTMLButtonElement> | — |
| onTransitionStart | TransitionEventHandler<HTMLButtonElement> | — |
| onTransitionStartCapture | TransitionEventHandler<HTMLButtonElement> | — |
| onWheel | WheelEventHandler<HTMLButtonElement> | — |
| onWheelCapture | WheelEventHandler<HTMLButtonElement> | — |
| Name | Type | Default |
|---|---|---|
| form | string | — |
The | ||
| formAction | string | ((formData: FormData) => void | Promise<void>) | — |
The URL that processes the information submitted by the button. Overrides the action attribute of the button's form owner. | ||
| formEncType | string | — |
Indicates how to encode the form data that is submitted. | ||
| formMethod | string | — |
Indicates the HTTP method used to submit the form. | ||
| formNoValidate | boolean | — |
Indicates that the form is not to be validated when it is submitted. | ||
| formTarget | string | — |
Overrides the target attribute of the button's form owner. | ||
| name | string | — |
Submitted as a pair with the button's value as part of the form data. | ||
| type | "button" | "reset" | "submit" | 'button' |
The behavior of the button when used in an HTML form. | ||
| value | string | — |
The value associated with the button's name when it's submitted with the form data. | ||
| Name | Type | Default |
|---|---|---|
| className | ClassNameOrFunction<ButtonRenderProps> | 'react-aria-Button' |
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state. | ||
| style | StyleOrFunction<ButtonRenderProps> | — |
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state. | ||
Combobox.ClearButton
| Name | Type | Default |
|---|---|---|
| children | ReactNode | — |
The content or child elements nested within this component. | ||
| Name | Type | Default |
|---|---|---|
| id | string | — |
The unique identifier for the DOM element. | ||
| role | AriaRole | — |
The ARIA role assigned to the element to improve accessibility. Example roles include "button", "navigation", "dialog", etc. | ||
| Name | Type | Default |
|---|---|---|
| className | string | — |
CSS class names to apply custom styling. | ||
| style | CSSProperties | — |
Inline styles specified as a React-compatible CSS properties object. | ||
Combobox.Description
| Name | Type | Default |
|---|---|---|
| about | string | — |
| accessKey | string | — |
| autoSave | string | — |
| children | ReactNode | — |
| color | string | — |
| content | string | — |
| contextMenu | string | — |
| dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — |
| datatype | string | — |
| defaultChecked | boolean | — |
| elementType | string | — |
| exportparts | string | — |
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts (opens in new tab) | ||
| inlist | any | — |
| inputMode | "decimal" | "email" | "none" | "numeric" | "search" | "tel" | "text" | "url" | — |
Hints at the type of data that might be entered by the user while editing the element or its contents | ||
| isInvalid | boolean | — |
| itemID | string | — |
| itemProp | string | — |
| itemRef | string | — |
| itemScope | boolean | — |
| itemType | string | — |
| part | string | — |
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part (opens in new tab) | ||
| prefix | string | — |
| property | string | — |
| radioGroup | string | — |
| rel | string | — |
| resource | string | — |
| results | number | — |
| rev | string | — |
| security | string | — |
| title | string | — |
| typeof | string | — |
| unselectable | "off" | "on" | — |
| vocab | string | — |
| Name | Type | Default |
|---|---|---|
| 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 | "both" | "inline" | "list" | "none" | — |
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 | "false" | "mixed" | "true" | boolean | — |
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. See: aria-pressed 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 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 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 | "date" | "false" | "location" | "page" | "step" | "time" | "true" | boolean | — |
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 aria-readonly. | ||
| aria-errormessage | string | — |
Identifies the element that provides an error message for the object. See: aria-invalid 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-haspopup | "dialog" | "false" | "grid" | "listbox" | "menu" | "tree" | "true" | boolean | — |
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | ||
| aria-hidden | Booleanish | — |
Indicates whether the element is exposed to an accessibility API. See: aria-disabled. | ||
| aria-invalid | "false" | "grammar" | "spelling" | "true" | boolean | — |
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 | "assertive" | "off" | "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 | "false" | "mixed" | "true" | boolean | — |
Indicates the current "pressed" state of toggle buttons. See: aria-checked aria-selected. | ||
| aria-readonly | Booleanish | — |
Indicates that the element is not editable, but is otherwise operable. See: aria-disabled. | ||
| aria-relevant | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "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 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 aria-colspan. | ||
| aria-selected | Booleanish | — |
Indicates the current "selected" state of various widgets. See: aria-checked 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 | "ascending" | "descending" | "none" | "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. | ||
| id | string | — |
| role | AriaRole | — |
| aria-dropeffectDeprecated | "copy" | "execute" | "link" | "move" | "none" | "popup" | — |
Indicates what functions can be performed when a dragged object is released on the drop target. in ARIA 1.1 | ||
| aria-grabbedDeprecated | Booleanish | — |
Indicates an element's "grabbed" state in a drag-and-drop operation. in ARIA 1.1 | ||
| Name | Type | Default |
|---|---|---|
| autoCapitalize | "characters" | "none" | "off" | "on" | "sentences" | "words" | (string & {}) | — |
| autoCorrect | string | — |
| autoFocus | boolean | — |
| contentEditable | "inherit" | "plaintext-only" | Booleanish | — |
| dir | string | — |
| draggable | Booleanish | — |
| enterKeyHint | "done" | "enter" | "go" | "next" | "previous" | "search" | "send" | — |
| hidden | boolean | — |
| inert | boolean | — |
See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert | ||
| is | string | — |
Specify that a standard HTML element should behave like a defined custom built-in element See: https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is (opens in new tab) | ||
| lang | string | — |
| nonce | string | — |
| popover | "" | "auto" | "hint" | "manual" | — |
| popoverTarget | string | — |
| popoverTargetAction | "hide" | "show" | "toggle" | — |
| 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:
| ||
| slot | string | — |
| spellCheck | Booleanish | — |
| suppressContentEditableWarning | boolean | — |
| suppressHydrationWarning | boolean | — |
| tabIndex | number | — |
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| 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> | — |
| 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> | — |
| onKeyPressDeprecated | KeyboardEventHandler<HTMLElement> | — |
Use | ||
| onKeyPressCaptureDeprecated | KeyboardEventHandler<HTMLElement> | — |
Use | ||
| Name | Type | Default |
|---|---|---|
| defaultValue | string | number | readonly string[] | — |
| Name | Type | Default |
|---|---|---|
| className | string | — |
| style | CSSProperties | — |
Combobox.Error
| Name | Type | Default |
|---|---|---|
| children | ChildrenOrFunction<FieldErrorRenderProps> | — |
The children of the component. A function may be provided to alter the children based on component state. | ||
| elementType | string | 'span' |
The HTML element type to render. Defaults to | ||
| Name | Type | Default |
|---|---|---|
| id | string | — |
The element's unique identifier. See MDN (opens in new tab). | ||
| Name | Type | Default |
|---|---|---|
| dir | string | — |
| hidden | boolean | — |
| inert | boolean | — |
| lang | string | — |
| render | DOMRenderFunction<"div", 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:
| ||
| suppressHydrationWarning | boolean | — |
A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs (opens in new tab). | ||
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationStart | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAuxClick | MouseEventHandler<HTMLDivElement> | — |
| onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onClick | MouseEventHandler<HTMLDivElement> | — |
| onClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onContextMenu | MouseEventHandler<HTMLDivElement> | — |
| onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — |
| onDoubleClick | MouseEventHandler<HTMLDivElement> | — |
| onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — |
| onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — |
| onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — |
| onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — |
| onMouseDown | MouseEventHandler<HTMLDivElement> | — |
| onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseEnter | MouseEventHandler<HTMLDivElement> | — |
| onMouseLeave | MouseEventHandler<HTMLDivElement> | — |
| onMouseMove | MouseEventHandler<HTMLDivElement> | — |
| onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseOut | MouseEventHandler<HTMLDivElement> | — |
| onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseOver | MouseEventHandler<HTMLDivElement> | — |
| onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseUp | MouseEventHandler<HTMLDivElement> | — |
| onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — |
| onPointerCancel | PointerEventHandler<HTMLDivElement> | — |
| onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerDown | PointerEventHandler<HTMLDivElement> | — |
| onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerEnter | PointerEventHandler<HTMLDivElement> | — |
| onPointerLeave | PointerEventHandler<HTMLDivElement> | — |
| onPointerMove | PointerEventHandler<HTMLDivElement> | — |
| onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerOut | PointerEventHandler<HTMLDivElement> | — |
| onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerOver | PointerEventHandler<HTMLDivElement> | — |
| onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — |
| onPointerUp | PointerEventHandler<HTMLDivElement> | — |
| onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — |
| onScroll | UIEventHandler<HTMLDivElement> | — |
| onScrollCapture | UIEventHandler<HTMLDivElement> | — |
| onTouchCancel | TouchEventHandler<HTMLDivElement> | — |
| onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchEnd | TouchEventHandler<HTMLDivElement> | — |
| onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchMove | TouchEventHandler<HTMLDivElement> | — |
| onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchStart | TouchEventHandler<HTMLDivElement> | — |
| onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — |
| onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionRun | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionStart | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — |
| onWheel | WheelEventHandler<HTMLDivElement> | — |
| onWheelCapture | WheelEventHandler<HTMLDivElement> | — |
| Name | Type | Default |
|---|---|---|
| className | ClassNameOrFunction<FieldErrorRenderProps> | 'react-aria-FieldError' |
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state. | ||
| style | StyleOrFunction<FieldErrorRenderProps> | — |
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state. | ||
Combobox.Input
| Name | Type | Default |
|---|---|---|
| about | string | — |
| accept | string | — |
| accessKey | string | — |
| alignment | "left" | "right" | left |
Alignment of the text inside the input | ||
| alt | string | — |
| autoSave | string | — |
| capture | "environment" | "user" | boolean | — |
| checked | boolean | — |
| children | ReactNode | — |
| color | string | — |
| content | string | — |
| contextMenu | string | — |
| dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — |
| datatype | string | — |
| defaultChecked | boolean | — |
| disabled | boolean | — |
| exportparts | string | — |
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts (opens in new tab) | ||
| height | string | number | — |
| inlist | any | — |
| inputMode | "decimal" | "email" | "none" | "numeric" | "search" | "tel" | "text" | "url" | — |
Hints at the type of data that might be entered by the user while editing the element or its contents | ||
| itemID | string | — |
| itemProp | string | — |
| itemRef | string | — |
| itemScope | boolean | — |
| itemType | string | — |
| list | string | — |
| multiple | boolean | — |
| part | string | — |
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part (opens in new tab) | ||
| prefix | string | — |
| property | string | — |
| radioGroup | string | — |
| readOnly | boolean | — |
| rel | string | — |
| required | boolean | — |
| resource | string | — |
| results | number | — |
| rev | string | — |
| security | string | — |
| size | "lg" | "md" | "sm" | "md" |
Controls height, padding, and typography of the input. | ||
| src | string | — |
| title | string | — |
| typeof | string | — |
| unselectable | "off" | "on" | — |
| vocab | string | — |
| width | string | number | — |
| compactDeprecated | boolean | — |
Use | ||
| Name | Type | Default |
|---|---|---|
| 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 | "both" | "inline" | "list" | "none" | — |
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 | "false" | "mixed" | "true" | boolean | — |
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. See: aria-pressed 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 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 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 | "date" | "false" | "location" | "page" | "step" | "time" | "true" | boolean | — |
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 aria-readonly. | ||
| aria-errormessage | string | — |
Identifies the element that provides an error message for the object. See: aria-invalid 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-haspopup | "dialog" | "false" | "grid" | "listbox" | "menu" | "tree" | "true" | boolean | — |
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | ||
| aria-hidden | Booleanish | — |
Indicates whether the element is exposed to an accessibility API. See: aria-disabled. | ||
| aria-invalid | "false" | "grammar" | "spelling" | "true" | boolean | — |
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 | "assertive" | "off" | "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 | "false" | "mixed" | "true" | boolean | — |
Indicates the current "pressed" state of toggle buttons. See: aria-checked aria-selected. | ||
| aria-readonly | Booleanish | — |
Indicates that the element is not editable, but is otherwise operable. See: aria-disabled. | ||
| aria-relevant | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "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 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 aria-colspan. | ||
| aria-selected | Booleanish | — |
Indicates the current "selected" state of various widgets. See: aria-checked 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 | "ascending" | "descending" | "none" | "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. | ||
| id | string | — |
| role | AriaRole | — |
| aria-dropeffectDeprecated | "copy" | "execute" | "link" | "move" | "none" | "popup" | — |
Indicates what functions can be performed when a dragged object is released on the drop target. in ARIA 1.1 | ||
| aria-grabbedDeprecated | Booleanish | — |
Indicates an element's "grabbed" state in a drag-and-drop operation. in ARIA 1.1 | ||
| Name | Type | Default |
|---|---|---|
| autoCapitalize | "characters" | "none" | "off" | "on" | "sentences" | "words" | (string & {}) | — |
| autoCorrect | string | — |
| autoFocus | boolean | — |
| contentEditable | "inherit" | "plaintext-only" | Booleanish | — |
| dir | string | — |
| draggable | Booleanish | — |
| enterKeyHint | "done" | "enter" | "go" | "next" | "previous" | "search" | "send" | — |
| hidden | boolean | — |
| inert | boolean | — |
See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert | ||
| is | string | — |
Specify that a standard HTML element should behave like a defined custom built-in element See: https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is (opens in new tab) | ||
| lang | string | — |
| nonce | string | — |
| popover | "" | "auto" | "hint" | "manual" | — |
| popoverTarget | string | — |
| popoverTargetAction | "hide" | "show" | "toggle" | — |
| ref | Ref<HTMLInputElement> | — |
Requires React 19 | ||
| render | DOMRenderFunction<"input", InputRenderProps> | — |
Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements:
| ||
| slot | string | — |
| spellCheck | Booleanish | — |
| suppressContentEditableWarning | boolean | — |
| suppressHydrationWarning | boolean | — |
| tabIndex | number | — |
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| onAbort | ReactEventHandler<HTMLInputElement> | — |
| onAbortCapture | ReactEventHandler<HTMLInputElement> | — |
| onAnimationEnd | AnimationEventHandler<HTMLInputElement> | — |
| onAnimationEndCapture | AnimationEventHandler<HTMLInputElement> | — |
| onAnimationIteration | AnimationEventHandler<HTMLInputElement> | — |
| onAnimationIterationCapture | AnimationEventHandler<HTMLInputElement> | — |
| onAnimationStart | AnimationEventHandler<HTMLInputElement> | — |
| onAnimationStartCapture | AnimationEventHandler<HTMLInputElement> | — |
| onAuxClick | MouseEventHandler<HTMLInputElement> | — |
| onAuxClickCapture | MouseEventHandler<HTMLInputElement> | — |
| onBeforeInput | InputEventHandler<HTMLInputElement> | — |
| onBeforeInputCapture | FormEventHandler<HTMLInputElement> | — |
| onBeforeToggle | ToggleEventHandler<HTMLInputElement> | — |
| onBlur | FocusEventHandler<HTMLInputElement> | — |
| onBlurCapture | FocusEventHandler<HTMLInputElement> | — |
| onCanPlay | ReactEventHandler<HTMLInputElement> | — |
| onCanPlayCapture | ReactEventHandler<HTMLInputElement> | — |
| onCanPlayThrough | ReactEventHandler<HTMLInputElement> | — |
| onCanPlayThroughCapture | ReactEventHandler<HTMLInputElement> | — |
| onChange | ChangeEventHandler<HTMLInputElement> | — |
| onChangeCapture | FormEventHandler<HTMLInputElement> | — |
| onClick | MouseEventHandler<HTMLInputElement> | — |
| onClickCapture | MouseEventHandler<HTMLInputElement> | — |
| onCompositionEnd | CompositionEventHandler<HTMLInputElement> | — |
| onCompositionEndCapture | CompositionEventHandler<HTMLInputElement> | — |
| onCompositionStart | CompositionEventHandler<HTMLInputElement> | — |
| onCompositionStartCapture | CompositionEventHandler<HTMLInputElement> | — |
| onCompositionUpdate | CompositionEventHandler<HTMLInputElement> | — |
| onCompositionUpdateCapture | CompositionEventHandler<HTMLInputElement> | — |
| onContextMenu | MouseEventHandler<HTMLInputElement> | — |
| onContextMenuCapture | MouseEventHandler<HTMLInputElement> | — |
| onCopy | ClipboardEventHandler<HTMLInputElement> | — |
| onCopyCapture | ClipboardEventHandler<HTMLInputElement> | — |
| onCut | ClipboardEventHandler<HTMLInputElement> | — |
| onCutCapture | ClipboardEventHandler<HTMLInputElement> | — |
| onDoubleClick | MouseEventHandler<HTMLInputElement> | — |
| onDoubleClickCapture | MouseEventHandler<HTMLInputElement> | — |
| onDrag | DragEventHandler<HTMLInputElement> | — |
| onDragCapture | DragEventHandler<HTMLInputElement> | — |
| onDragEnd | DragEventHandler<HTMLInputElement> | — |
| onDragEndCapture | DragEventHandler<HTMLInputElement> | — |
| onDragEnter | DragEventHandler<HTMLInputElement> | — |
| onDragEnterCapture | DragEventHandler<HTMLInputElement> | — |
| onDragExit | DragEventHandler<HTMLInputElement> | — |
| onDragExitCapture | DragEventHandler<HTMLInputElement> | — |
| onDragLeave | DragEventHandler<HTMLInputElement> | — |
| onDragLeaveCapture | DragEventHandler<HTMLInputElement> | — |
| onDragOver | DragEventHandler<HTMLInputElement> | — |
| onDragOverCapture | DragEventHandler<HTMLInputElement> | — |
| onDragStart | DragEventHandler<HTMLInputElement> | — |
| onDragStartCapture | DragEventHandler<HTMLInputElement> | — |
| onDrop | DragEventHandler<HTMLInputElement> | — |
| onDropCapture | DragEventHandler<HTMLInputElement> | — |
| onDurationChange | ReactEventHandler<HTMLInputElement> | — |
| onDurationChangeCapture | ReactEventHandler<HTMLInputElement> | — |
| onEmptied | ReactEventHandler<HTMLInputElement> | — |
| onEmptiedCapture | ReactEventHandler<HTMLInputElement> | — |
| onEncrypted | ReactEventHandler<HTMLInputElement> | — |
| onEncryptedCapture | ReactEventHandler<HTMLInputElement> | — |
| onEnded | ReactEventHandler<HTMLInputElement> | — |
| onEndedCapture | ReactEventHandler<HTMLInputElement> | — |
| onError | ReactEventHandler<HTMLInputElement> | — |
| onErrorCapture | ReactEventHandler<HTMLInputElement> | — |
| onFocus | FocusEventHandler<HTMLInputElement> | — |
| onFocusCapture | FocusEventHandler<HTMLInputElement> | — |
| onGotPointerCapture | PointerEventHandler<HTMLInputElement> | — |
| onGotPointerCaptureCapture | PointerEventHandler<HTMLInputElement> | — |
| 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<HTMLInputElement> | — |
| onInputCapture | FormEventHandler<HTMLInputElement> | — |
| onInvalid | FormEventHandler<HTMLInputElement> | — |
| onInvalidCapture | FormEventHandler<HTMLInputElement> | — |
| onKeyDown | KeyboardEventHandler<HTMLInputElement> | — |
| onKeyDownCapture | KeyboardEventHandler<HTMLInputElement> | — |
| onKeyUp | KeyboardEventHandler<HTMLInputElement> | — |
| onKeyUpCapture | KeyboardEventHandler<HTMLInputElement> | — |
| onLoad | ReactEventHandler<HTMLInputElement> | — |
| onLoadCapture | ReactEventHandler<HTMLInputElement> | — |
| onLoadedData | ReactEventHandler<HTMLInputElement> | — |
| onLoadedDataCapture | ReactEventHandler<HTMLInputElement> | — |
| onLoadedMetadata | ReactEventHandler<HTMLInputElement> | — |
| onLoadedMetadataCapture | ReactEventHandler<HTMLInputElement> | — |
| onLoadStart | ReactEventHandler<HTMLInputElement> | — |
| onLoadStartCapture | ReactEventHandler<HTMLInputElement> | — |
| onLostPointerCapture | PointerEventHandler<HTMLInputElement> | — |
| onLostPointerCaptureCapture | PointerEventHandler<HTMLInputElement> | — |
| onMouseDown | MouseEventHandler<HTMLInputElement> | — |
| onMouseDownCapture | MouseEventHandler<HTMLInputElement> | — |
| onMouseEnter | MouseEventHandler<HTMLInputElement> | — |
| onMouseLeave | MouseEventHandler<HTMLInputElement> | — |
| onMouseMove | MouseEventHandler<HTMLInputElement> | — |
| onMouseMoveCapture | MouseEventHandler<HTMLInputElement> | — |
| onMouseOut | MouseEventHandler<HTMLInputElement> | — |
| onMouseOutCapture | MouseEventHandler<HTMLInputElement> | — |
| onMouseOver | MouseEventHandler<HTMLInputElement> | — |
| onMouseOverCapture | MouseEventHandler<HTMLInputElement> | — |
| onMouseUp | MouseEventHandler<HTMLInputElement> | — |
| onMouseUpCapture | MouseEventHandler<HTMLInputElement> | — |
| onPaste | ClipboardEventHandler<HTMLInputElement> | — |
| onPasteCapture | ClipboardEventHandler<HTMLInputElement> | — |
| onPause | ReactEventHandler<HTMLInputElement> | — |
| onPauseCapture | ReactEventHandler<HTMLInputElement> | — |
| onPlay | ReactEventHandler<HTMLInputElement> | — |
| onPlayCapture | ReactEventHandler<HTMLInputElement> | — |
| onPlaying | ReactEventHandler<HTMLInputElement> | — |
| onPlayingCapture | ReactEventHandler<HTMLInputElement> | — |
| onPointerCancel | PointerEventHandler<HTMLInputElement> | — |
| onPointerCancelCapture | PointerEventHandler<HTMLInputElement> | — |
| onPointerDown | PointerEventHandler<HTMLInputElement> | — |
| onPointerDownCapture | PointerEventHandler<HTMLInputElement> | — |
| onPointerEnter | PointerEventHandler<HTMLInputElement> | — |
| onPointerLeave | PointerEventHandler<HTMLInputElement> | — |
| onPointerMove | PointerEventHandler<HTMLInputElement> | — |
| onPointerMoveCapture | PointerEventHandler<HTMLInputElement> | — |
| onPointerOut | PointerEventHandler<HTMLInputElement> | — |
| onPointerOutCapture | PointerEventHandler<HTMLInputElement> | — |
| onPointerOver | PointerEventHandler<HTMLInputElement> | — |
| onPointerOverCapture | PointerEventHandler<HTMLInputElement> | — |
| onPointerUp | PointerEventHandler<HTMLInputElement> | — |
| onPointerUpCapture | PointerEventHandler<HTMLInputElement> | — |
| onProgress | ReactEventHandler<HTMLInputElement> | — |
| onProgressCapture | ReactEventHandler<HTMLInputElement> | — |
| onRateChange | ReactEventHandler<HTMLInputElement> | — |
| onRateChangeCapture | ReactEventHandler<HTMLInputElement> | — |
| onReset | FormEventHandler<HTMLInputElement> | — |
| onResetCapture | FormEventHandler<HTMLInputElement> | — |
| onScroll | UIEventHandler<HTMLInputElement> | — |
| onScrollCapture | UIEventHandler<HTMLInputElement> | — |
| onScrollEnd | UIEventHandler<HTMLInputElement> | — |
| onScrollEndCapture | UIEventHandler<HTMLInputElement> | — |
| onSeeked | ReactEventHandler<HTMLInputElement> | — |
| onSeekedCapture | ReactEventHandler<HTMLInputElement> | — |
| onSeeking | ReactEventHandler<HTMLInputElement> | — |
| onSeekingCapture | ReactEventHandler<HTMLInputElement> | — |
| onSelect | ReactEventHandler<HTMLInputElement> | — |
| onSelectCapture | ReactEventHandler<HTMLInputElement> | — |
| onStalled | ReactEventHandler<HTMLInputElement> | — |
| onStalledCapture | ReactEventHandler<HTMLInputElement> | — |
| onSubmit | FormEventHandler<HTMLInputElement> | — |
| onSubmitCapture | FormEventHandler<HTMLInputElement> | — |
| onSuspend | ReactEventHandler<HTMLInputElement> | — |
| onSuspendCapture | ReactEventHandler<HTMLInputElement> | — |
| onTimeUpdate | ReactEventHandler<HTMLInputElement> | — |
| onTimeUpdateCapture | ReactEventHandler<HTMLInputElement> | — |
| onToggle | ToggleEventHandler<HTMLInputElement> | — |
| onTouchCancel | TouchEventHandler<HTMLInputElement> | — |
| onTouchCancelCapture | TouchEventHandler<HTMLInputElement> | — |
| onTouchEnd | TouchEventHandler<HTMLInputElement> | — |
| onTouchEndCapture | TouchEventHandler<HTMLInputElement> | — |
| onTouchMove | TouchEventHandler<HTMLInputElement> | — |
| onTouchMoveCapture | TouchEventHandler<HTMLInputElement> | — |
| onTouchStart | TouchEventHandler<HTMLInputElement> | — |
| onTouchStartCapture | TouchEventHandler<HTMLInputElement> | — |
| onTransitionCancel | TransitionEventHandler<HTMLInputElement> | — |
| onTransitionCancelCapture | TransitionEventHandler<HTMLInputElement> | — |
| onTransitionEnd | TransitionEventHandler<HTMLInputElement> | — |
| onTransitionEndCapture | TransitionEventHandler<HTMLInputElement> | — |
| onTransitionRun | TransitionEventHandler<HTMLInputElement> | — |
| onTransitionRunCapture | TransitionEventHandler<HTMLInputElement> | — |
| onTransitionStart | TransitionEventHandler<HTMLInputElement> | — |
| onTransitionStartCapture | TransitionEventHandler<HTMLInputElement> | — |
| onVolumeChange | ReactEventHandler<HTMLInputElement> | — |
| onVolumeChangeCapture | ReactEventHandler<HTMLInputElement> | — |
| onWaiting | ReactEventHandler<HTMLInputElement> | — |
| onWaitingCapture | ReactEventHandler<HTMLInputElement> | — |
| onWheel | WheelEventHandler<HTMLInputElement> | — |
| onWheelCapture | WheelEventHandler<HTMLInputElement> | — |
| onKeyPressDeprecated | KeyboardEventHandler<HTMLInputElement> | — |
Use | ||
| onKeyPressCaptureDeprecated | KeyboardEventHandler<HTMLInputElement> | — |
Use | ||
| Name | Type | Default |
|---|---|---|
| autoComplete | HTMLInputAutoCompleteAttribute | — |
| defaultValue | string | number | readonly string[] | — |
| form | string | — |
| formAction | string | ((formData: FormData) => void | Promise<void>) | — |
| formEncType | string | — |
| formMethod | string | — |
| formNoValidate | boolean | — |
| formTarget | string | — |
| max | string | number | — |
| maxLength | number | — |
| min | string | number | — |
| minLength | number | — |
| name | string | — |
| pattern | string | — |
| placeholder | string | — |
Temporary text that occupies the text input when it is empty. See MDN (opens in new tab). | ||
| step | string | number | — |
| type | HTMLInputTypeAttribute | — |
| value | string | number | readonly string[] | — |
| Name | Type | Default |
|---|---|---|
| className | ClassNameOrFunction<InputRenderProps> | 'react-aria-Input' |
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state. | ||
| style | StyleOrFunction<InputRenderProps> | — |
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state. | ||
Combobox.Item
| Name | Type | Default |
|---|---|---|
| children | ChildrenOrFunction<ListBoxItemRenderProps> | — |
The children of the component. A function may be provided to alter the children based on component state. | ||
| download | string | boolean | — |
Causes the browser to download the linked URL. A string may be provided to suggest a file name. See MDN (opens in new tab). | ||
| href | string | — |
A URL to link to. See MDN (opens in new tab). | ||
| hrefLang | string | — |
Hints at the human language of the linked URL. SeeMDN (opens in new tab). | ||
| isDisabled | boolean | — |
Whether the item is disabled. | ||
| ping | string | — |
A space-separated list of URLs to ping when the link is followed. See MDN (opens in new tab). | ||
| referrerPolicy | HTMLAttributeReferrerPolicy | — |
How much of the referrer to send when following the link. See MDN (opens in new tab). | ||
| rel | string | — |
The relationship between the linked resource and the current page. See MDN (opens in new tab). | ||
| routerOptions | undefined | — |
Options for the configured client side router. | ||
| target | HTMLAttributeAnchorTarget | — |
The target window for the link. See MDN (opens in new tab). | ||
| textValue | string | — |
A string representation of the item's contents, used for features like typeahead. | ||
| Name | Type | Default |
|---|---|---|
| aria-label | string | — |
An accessibility label for this item. | ||
| id | Key | — |
The unique id of the item. | ||
| Name | Type | Default |
|---|---|---|
| dir | string | — |
| hidden | boolean | — |
| inert | boolean | — |
| lang | string | — |
| render | ((props: DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement> | DetailedHTMLProps<LinkWithRequiredHref, HTMLAnchorElement>, renderProps: ListBoxItemRenderProps) => ReactElement<...>) | — |
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. Note: You can check if Requirements:
| ||
| suppressHydrationWarning | boolean | — |
A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs (opens in new tab). | ||
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| onAction | (() => void) | — |
Handler that is called when a user performs an action on the item. The exact user event depends on the collection's | ||
| 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<HTMLDivElement, Element>) => void) | — |
Handler that is called when the element loses focus. | ||
| onClick | ((e: MouseEvent<FocusableElement, MouseEvent>) => void) | — |
Not recommended – use `onPress` instead. | ||
| onClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onContextMenu | MouseEventHandler<HTMLDivElement> | — |
| onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — |
| onDoubleClick | MouseEventHandler<HTMLDivElement> | — |
| onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onFocus | ((e: FocusEvent<HTMLDivElement, 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> | — |
| onHoverChange | ((isHovering: boolean) => void) | — |
Handler that is called when the hover state changes. | ||
| onHoverEnd | ((e: HoverEvent) => void) | — |
Handler that is called when a hover interaction ends. | ||
| onHoverStart | ((e: HoverEvent) => void) | — |
Handler that is called when a hover interaction starts. | ||
| onKeyDown | ((e: KeyboardEvent) => void) | — |
Handler that is called when a key is pressed. | ||
| onKeyUp | ((e: KeyboardEvent) => void) | — |
Handler that is called when a key is released. | ||
| onLostPointerCapture | PointerEventHandler<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> | — |
| onPress | ((e: PressEvent) => void) | — |
Handler that is called when the press is released over the target. | ||
| onPressChange | ((isPressed: boolean) => void) | — |
Handler that is called when the press state changes. | ||
| onPressEnd | ((e: PressEvent) => void) | — |
Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target. | ||
| onPressStart | ((e: PressEvent) => void) | — |
Handler that is called when a press interaction starts. | ||
| onPressUp | ((e: PressEvent) => void) | — |
Handler that is called when a press is released over the target, regardless of whether it started on the target or not. | ||
| onScroll | UIEventHandler<HTMLDivElement> | — |
| onScrollCapture | UIEventHandler<HTMLDivElement> | — |
| onTouchCancel | TouchEventHandler<HTMLDivElement> | — |
| onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchEnd | TouchEventHandler<HTMLDivElement> | — |
| onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchMove | TouchEventHandler<HTMLDivElement> | — |
| onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchStart | TouchEventHandler<HTMLDivElement> | — |
| onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — |
| onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionRun | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionStart | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — |
| onWheel | WheelEventHandler<HTMLDivElement> | — |
| onWheelCapture | WheelEventHandler<HTMLDivElement> | — |
| Name | Type | Default |
|---|---|---|
| value | object | — |
The object value that this item represents. When using dynamic collections, this is set automatically. | ||
| Name | Type | Default |
|---|---|---|
| className | ClassNameOrFunction<ListBoxItemRenderProps> | 'react-aria-ListBoxItem' |
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state. | ||
| style | StyleOrFunction<ListBoxItemRenderProps> | — |
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state. | ||
Combobox.Label
| Name | Type | Default |
|---|---|---|
| about | string | — |
| accessKey | string | — |
| autoSave | string | — |
| children | ReactNode | — |
| color | string | — |
| content | string | — |
| contextMenu | string | — |
| dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — |
| datatype | string | — |
| defaultChecked | boolean | — |
| elementType | string | — |
| exportparts | string | — |
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts (opens in new tab) | ||
| htmlFor | string | — |
| inlist | any | — |
| inputMode | "decimal" | "email" | "none" | "numeric" | "search" | "tel" | "text" | "url" | — |
Hints at the type of data that might be entered by the user while editing the element or its contents | ||
| isDisabled | boolean | — |
Whether the Label is on a disabled input or element. | ||
| isRequired | boolean | — |
Whether the Label is on a required input or element. | ||
| itemID | string | — |
| itemProp | string | — |
| itemRef | string | — |
| itemScope | boolean | — |
| itemType | string | — |
| part | string | — |
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part (opens in new tab) | ||
| prefix | string | — |
| property | string | — |
| radioGroup | string | — |
| rel | string | — |
| resource | string | — |
| results | number | — |
| rev | string | — |
| security | string | — |
| title | string | — |
| typeof | string | — |
| unselectable | "off" | "on" | — |
| vocab | string | — |
| Name | Type | Default |
|---|---|---|
| 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 | "both" | "inline" | "list" | "none" | — |
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 | "false" | "mixed" | "true" | boolean | — |
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. See: aria-pressed 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 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 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 | "date" | "false" | "location" | "page" | "step" | "time" | "true" | boolean | — |
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 aria-readonly. | ||
| aria-errormessage | string | — |
Identifies the element that provides an error message for the object. See: aria-invalid 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-haspopup | "dialog" | "false" | "grid" | "listbox" | "menu" | "tree" | "true" | boolean | — |
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | ||
| aria-hidden | Booleanish | — |
Indicates whether the element is exposed to an accessibility API. See: aria-disabled. | ||
| aria-invalid | "false" | "grammar" | "spelling" | "true" | boolean | — |
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 | "assertive" | "off" | "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 | "false" | "mixed" | "true" | boolean | — |
Indicates the current "pressed" state of toggle buttons. See: aria-checked aria-selected. | ||
| aria-readonly | Booleanish | — |
Indicates that the element is not editable, but is otherwise operable. See: aria-disabled. | ||
| aria-relevant | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "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 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 aria-colspan. | ||
| aria-selected | Booleanish | — |
Indicates the current "selected" state of various widgets. See: aria-checked 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 | "ascending" | "descending" | "none" | "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. | ||
| id | string | — |
| role | AriaRole | — |
| aria-dropeffectDeprecated | "copy" | "execute" | "link" | "move" | "none" | "popup" | — |
Indicates what functions can be performed when a dragged object is released on the drop target. in ARIA 1.1 | ||
| aria-grabbedDeprecated | Booleanish | — |
Indicates an element's "grabbed" state in a drag-and-drop operation. in ARIA 1.1 | ||
| Name | Type | Default |
|---|---|---|
| autoCapitalize | "characters" | "none" | "off" | "on" | "sentences" | "words" | (string & {}) | — |
| autoCorrect | string | — |
| autoFocus | boolean | — |
| contentEditable | "inherit" | "plaintext-only" | Booleanish | — |
| dir | string | — |
| draggable | Booleanish | — |
| enterKeyHint | "done" | "enter" | "go" | "next" | "previous" | "search" | "send" | — |
| hidden | boolean | — |
| inert | boolean | — |
See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert | ||
| is | string | — |
Specify that a standard HTML element should behave like a defined custom built-in element See: https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is (opens in new tab) | ||
| lang | string | — |
| nonce | string | — |
| popover | "" | "auto" | "hint" | "manual" | — |
| popoverTarget | string | — |
| popoverTargetAction | "hide" | "show" | "toggle" | — |
| 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:
| ||
| slot | string | — |
| spellCheck | Booleanish | — |
| suppressContentEditableWarning | boolean | — |
| suppressHydrationWarning | boolean | — |
| tabIndex | number | — |
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| 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> | — |
| 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> | — |
| onKeyPressDeprecated | KeyboardEventHandler<HTMLLabelElement> | — |
Use | ||
| onKeyPressCaptureDeprecated | KeyboardEventHandler<HTMLLabelElement> | — |
Use | ||
| Name | Type | Default |
|---|---|---|
| defaultValue | string | number | readonly string[] | — |
| form | string | — |
| Name | Type | Default |
|---|---|---|
| className | string | — |
| style | CSSProperties | — |
Combobox.LeadingIcon
| Name | Type | Default |
|---|---|---|
| about | string | — |
| accessKey | string | — |
| autoSave | string | — |
| children | ReactNode | — |
| color | string | — |
| content | string | — |
| contextMenu | string | — |
| dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — |
| datatype | string | — |
| defaultChecked | boolean | — |
| exportparts | string | — |
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts (opens in new tab) | ||
| inlist | any | — |
| inputMode | "decimal" | "email" | "none" | "numeric" | "search" | "tel" | "text" | "url" | — |
Hints at the type of data that might be entered by the user while editing the element or its contents | ||
| itemID | string | — |
| itemProp | string | — |
| itemRef | string | — |
| itemScope | boolean | — |
| itemType | string | — |
| part | string | — |
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part (opens in new tab) | ||
| prefix | string | — |
| property | string | — |
| radioGroup | string | — |
| rel | string | — |
| resource | string | — |
| results | number | — |
| rev | string | — |
| security | string | — |
| title | string | — |
| typeof | string | — |
| unselectable | "off" | "on" | — |
| vocab | string | — |
| Name | Type | Default |
|---|---|---|
| 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 | "both" | "inline" | "list" | "none" | — |
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 | "false" | "mixed" | "true" | boolean | — |
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. See: aria-pressed 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 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 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 | "date" | "false" | "location" | "page" | "step" | "time" | "true" | boolean | — |
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 aria-readonly. | ||
| aria-errormessage | string | — |
Identifies the element that provides an error message for the object. See: aria-invalid 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-haspopup | "dialog" | "false" | "grid" | "listbox" | "menu" | "tree" | "true" | boolean | — |
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | ||
| aria-hidden | Booleanish | — |
Indicates whether the element is exposed to an accessibility API. See: aria-disabled. | ||
| aria-invalid | "false" | "grammar" | "spelling" | "true" | boolean | — |
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 | "assertive" | "off" | "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 | "false" | "mixed" | "true" | boolean | — |
Indicates the current "pressed" state of toggle buttons. See: aria-checked aria-selected. | ||
| aria-readonly | Booleanish | — |
Indicates that the element is not editable, but is otherwise operable. See: aria-disabled. | ||
| aria-relevant | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "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 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 aria-colspan. | ||
| aria-selected | Booleanish | — |
Indicates the current "selected" state of various widgets. See: aria-checked 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 | "ascending" | "descending" | "none" | "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. | ||
| id | string | — |
| role | AriaRole | — |
| aria-dropeffectDeprecated | "copy" | "execute" | "link" | "move" | "none" | "popup" | — |
Indicates what functions can be performed when a dragged object is released on the drop target. in ARIA 1.1 | ||
| aria-grabbedDeprecated | Booleanish | — |
Indicates an element's "grabbed" state in a drag-and-drop operation. in ARIA 1.1 | ||
| Name | Type | Default |
|---|---|---|
| autoCapitalize | "characters" | "none" | "off" | "on" | "sentences" | "words" | (string & {}) | — |
| autoCorrect | string | — |
| autoFocus | boolean | — |
| contentEditable | "inherit" | "plaintext-only" | Booleanish | — |
| dir | string | — |
| draggable | Booleanish | — |
| enterKeyHint | "done" | "enter" | "go" | "next" | "previous" | "search" | "send" | — |
| hidden | boolean | — |
| inert | boolean | — |
See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert | ||
| is | string | — |
Specify that a standard HTML element should behave like a defined custom built-in element See: https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is (opens in new tab) | ||
| lang | string | — |
| nonce | string | — |
| popover | "" | "auto" | "hint" | "manual" | — |
| popoverTarget | string | — |
| popoverTargetAction | "hide" | "show" | "toggle" | — |
| slot | string | — |
| spellCheck | Booleanish | — |
| suppressContentEditableWarning | boolean | — |
| suppressHydrationWarning | boolean | — |
| tabIndex | number | — |
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| onAbort | ReactEventHandler<HTMLSpanElement> | — |
| onAbortCapture | ReactEventHandler<HTMLSpanElement> | — |
| onAnimationEnd | AnimationEventHandler<HTMLSpanElement> | — |
| onAnimationEndCapture | AnimationEventHandler<HTMLSpanElement> | — |
| onAnimationIteration | AnimationEventHandler<HTMLSpanElement> | — |
| onAnimationIterationCapture | AnimationEventHandler<HTMLSpanElement> | — |
| onAnimationStart | AnimationEventHandler<HTMLSpanElement> | — |
| onAnimationStartCapture | AnimationEventHandler<HTMLSpanElement> | — |
| onAuxClick | MouseEventHandler<HTMLSpanElement> | — |
| onAuxClickCapture | MouseEventHandler<HTMLSpanElement> | — |
| onBeforeInput | InputEventHandler<HTMLSpanElement> | — |
| onBeforeInputCapture | FormEventHandler<HTMLSpanElement> | — |
| onBeforeToggle | ToggleEventHandler<HTMLSpanElement> | — |
| onBlur | FocusEventHandler<HTMLSpanElement> | — |
| onBlurCapture | FocusEventHandler<HTMLSpanElement> | — |
| onCanPlay | ReactEventHandler<HTMLSpanElement> | — |
| onCanPlayCapture | ReactEventHandler<HTMLSpanElement> | — |
| onCanPlayThrough | ReactEventHandler<HTMLSpanElement> | — |
| onCanPlayThroughCapture | ReactEventHandler<HTMLSpanElement> | — |
| onChange | FormEventHandler<HTMLSpanElement> | — |
| onChangeCapture | FormEventHandler<HTMLSpanElement> | — |
| onClick | MouseEventHandler<HTMLSpanElement> | — |
| onClickCapture | MouseEventHandler<HTMLSpanElement> | — |
| onCompositionEnd | CompositionEventHandler<HTMLSpanElement> | — |
| onCompositionEndCapture | CompositionEventHandler<HTMLSpanElement> | — |
| onCompositionStart | CompositionEventHandler<HTMLSpanElement> | — |
| onCompositionStartCapture | CompositionEventHandler<HTMLSpanElement> | — |
| onCompositionUpdate | CompositionEventHandler<HTMLSpanElement> | — |
| onCompositionUpdateCapture | CompositionEventHandler<HTMLSpanElement> | — |
| onContextMenu | MouseEventHandler<HTMLSpanElement> | — |
| onContextMenuCapture | MouseEventHandler<HTMLSpanElement> | — |
| onCopy | ClipboardEventHandler<HTMLSpanElement> | — |
| onCopyCapture | ClipboardEventHandler<HTMLSpanElement> | — |
| onCut | ClipboardEventHandler<HTMLSpanElement> | — |
| onCutCapture | ClipboardEventHandler<HTMLSpanElement> | — |
| onDoubleClick | MouseEventHandler<HTMLSpanElement> | — |
| onDoubleClickCapture | MouseEventHandler<HTMLSpanElement> | — |
| onDrag | DragEventHandler<HTMLSpanElement> | — |
| onDragCapture | DragEventHandler<HTMLSpanElement> | — |
| onDragEnd | DragEventHandler<HTMLSpanElement> | — |
| onDragEndCapture | DragEventHandler<HTMLSpanElement> | — |
| onDragEnter | DragEventHandler<HTMLSpanElement> | — |
| onDragEnterCapture | DragEventHandler<HTMLSpanElement> | — |
| onDragExit | DragEventHandler<HTMLSpanElement> | — |
| onDragExitCapture | DragEventHandler<HTMLSpanElement> | — |
| onDragLeave | DragEventHandler<HTMLSpanElement> | — |
| onDragLeaveCapture | DragEventHandler<HTMLSpanElement> | — |
| onDragOver | DragEventHandler<HTMLSpanElement> | — |
| onDragOverCapture | DragEventHandler<HTMLSpanElement> | — |
| onDragStart | DragEventHandler<HTMLSpanElement> | — |
| onDragStartCapture | DragEventHandler<HTMLSpanElement> | — |
| onDrop | DragEventHandler<HTMLSpanElement> | — |
| onDropCapture | DragEventHandler<HTMLSpanElement> | — |
| onDurationChange | ReactEventHandler<HTMLSpanElement> | — |
| onDurationChangeCapture | ReactEventHandler<HTMLSpanElement> | — |
| onEmptied | ReactEventHandler<HTMLSpanElement> | — |
| onEmptiedCapture | ReactEventHandler<HTMLSpanElement> | — |
| onEncrypted | ReactEventHandler<HTMLSpanElement> | — |
| onEncryptedCapture | ReactEventHandler<HTMLSpanElement> | — |
| onEnded | ReactEventHandler<HTMLSpanElement> | — |
| onEndedCapture | ReactEventHandler<HTMLSpanElement> | — |
| onError | ReactEventHandler<HTMLSpanElement> | — |
| onErrorCapture | ReactEventHandler<HTMLSpanElement> | — |
| onFocus | FocusEventHandler<HTMLSpanElement> | — |
| onFocusCapture | FocusEventHandler<HTMLSpanElement> | — |
| onGotPointerCapture | PointerEventHandler<HTMLSpanElement> | — |
| onGotPointerCaptureCapture | PointerEventHandler<HTMLSpanElement> | — |
| onInput | FormEventHandler<HTMLSpanElement> | — |
| onInputCapture | FormEventHandler<HTMLSpanElement> | — |
| onInvalid | FormEventHandler<HTMLSpanElement> | — |
| onInvalidCapture | FormEventHandler<HTMLSpanElement> | — |
| onKeyDown | KeyboardEventHandler<HTMLSpanElement> | — |
| onKeyDownCapture | KeyboardEventHandler<HTMLSpanElement> | — |
| onKeyUp | KeyboardEventHandler<HTMLSpanElement> | — |
| onKeyUpCapture | KeyboardEventHandler<HTMLSpanElement> | — |
| onLoad | ReactEventHandler<HTMLSpanElement> | — |
| onLoadCapture | ReactEventHandler<HTMLSpanElement> | — |
| onLoadedData | ReactEventHandler<HTMLSpanElement> | — |
| onLoadedDataCapture | ReactEventHandler<HTMLSpanElement> | — |
| onLoadedMetadata | ReactEventHandler<HTMLSpanElement> | — |
| onLoadedMetadataCapture | ReactEventHandler<HTMLSpanElement> | — |
| onLoadStart | ReactEventHandler<HTMLSpanElement> | — |
| onLoadStartCapture | ReactEventHandler<HTMLSpanElement> | — |
| onLostPointerCapture | PointerEventHandler<HTMLSpanElement> | — |
| onLostPointerCaptureCapture | PointerEventHandler<HTMLSpanElement> | — |
| onMouseDown | MouseEventHandler<HTMLSpanElement> | — |
| onMouseDownCapture | MouseEventHandler<HTMLSpanElement> | — |
| onMouseEnter | MouseEventHandler<HTMLSpanElement> | — |
| onMouseLeave | MouseEventHandler<HTMLSpanElement> | — |
| onMouseMove | MouseEventHandler<HTMLSpanElement> | — |
| onMouseMoveCapture | MouseEventHandler<HTMLSpanElement> | — |
| onMouseOut | MouseEventHandler<HTMLSpanElement> | — |
| onMouseOutCapture | MouseEventHandler<HTMLSpanElement> | — |
| onMouseOver | MouseEventHandler<HTMLSpanElement> | — |
| onMouseOverCapture | MouseEventHandler<HTMLSpanElement> | — |
| onMouseUp | MouseEventHandler<HTMLSpanElement> | — |
| onMouseUpCapture | MouseEventHandler<HTMLSpanElement> | — |
| onPaste | ClipboardEventHandler<HTMLSpanElement> | — |
| onPasteCapture | ClipboardEventHandler<HTMLSpanElement> | — |
| onPause | ReactEventHandler<HTMLSpanElement> | — |
| onPauseCapture | ReactEventHandler<HTMLSpanElement> | — |
| onPlay | ReactEventHandler<HTMLSpanElement> | — |
| onPlayCapture | ReactEventHandler<HTMLSpanElement> | — |
| onPlaying | ReactEventHandler<HTMLSpanElement> | — |
| onPlayingCapture | ReactEventHandler<HTMLSpanElement> | — |
| onPointerCancel | PointerEventHandler<HTMLSpanElement> | — |
| onPointerCancelCapture | PointerEventHandler<HTMLSpanElement> | — |
| onPointerDown | PointerEventHandler<HTMLSpanElement> | — |
| onPointerDownCapture | PointerEventHandler<HTMLSpanElement> | — |
| onPointerEnter | PointerEventHandler<HTMLSpanElement> | — |
| onPointerLeave | PointerEventHandler<HTMLSpanElement> | — |
| onPointerMove | PointerEventHandler<HTMLSpanElement> | — |
| onPointerMoveCapture | PointerEventHandler<HTMLSpanElement> | — |
| onPointerOut | PointerEventHandler<HTMLSpanElement> | — |
| onPointerOutCapture | PointerEventHandler<HTMLSpanElement> | — |
| onPointerOver | PointerEventHandler<HTMLSpanElement> | — |
| onPointerOverCapture | PointerEventHandler<HTMLSpanElement> | — |
| onPointerUp | PointerEventHandler<HTMLSpanElement> | — |
| onPointerUpCapture | PointerEventHandler<HTMLSpanElement> | — |
| onProgress | ReactEventHandler<HTMLSpanElement> | — |
| onProgressCapture | ReactEventHandler<HTMLSpanElement> | — |
| onRateChange | ReactEventHandler<HTMLSpanElement> | — |
| onRateChangeCapture | ReactEventHandler<HTMLSpanElement> | — |
| onReset | FormEventHandler<HTMLSpanElement> | — |
| onResetCapture | FormEventHandler<HTMLSpanElement> | — |
| onScroll | UIEventHandler<HTMLSpanElement> | — |
| onScrollCapture | UIEventHandler<HTMLSpanElement> | — |
| onScrollEnd | UIEventHandler<HTMLSpanElement> | — |
| onScrollEndCapture | UIEventHandler<HTMLSpanElement> | — |
| onSeeked | ReactEventHandler<HTMLSpanElement> | — |
| onSeekedCapture | ReactEventHandler<HTMLSpanElement> | — |
| onSeeking | ReactEventHandler<HTMLSpanElement> | — |
| onSeekingCapture | ReactEventHandler<HTMLSpanElement> | — |
| onSelect | ReactEventHandler<HTMLSpanElement> | — |
| onSelectCapture | ReactEventHandler<HTMLSpanElement> | — |
| onStalled | ReactEventHandler<HTMLSpanElement> | — |
| onStalledCapture | ReactEventHandler<HTMLSpanElement> | — |
| onSubmit | FormEventHandler<HTMLSpanElement> | — |
| onSubmitCapture | FormEventHandler<HTMLSpanElement> | — |
| onSuspend | ReactEventHandler<HTMLSpanElement> | — |
| onSuspendCapture | ReactEventHandler<HTMLSpanElement> | — |
| onTimeUpdate | ReactEventHandler<HTMLSpanElement> | — |
| onTimeUpdateCapture | ReactEventHandler<HTMLSpanElement> | — |
| onToggle | ToggleEventHandler<HTMLSpanElement> | — |
| onTouchCancel | TouchEventHandler<HTMLSpanElement> | — |
| onTouchCancelCapture | TouchEventHandler<HTMLSpanElement> | — |
| onTouchEnd | TouchEventHandler<HTMLSpanElement> | — |
| onTouchEndCapture | TouchEventHandler<HTMLSpanElement> | — |
| onTouchMove | TouchEventHandler<HTMLSpanElement> | — |
| onTouchMoveCapture | TouchEventHandler<HTMLSpanElement> | — |
| onTouchStart | TouchEventHandler<HTMLSpanElement> | — |
| onTouchStartCapture | TouchEventHandler<HTMLSpanElement> | — |
| onTransitionCancel | TransitionEventHandler<HTMLSpanElement> | — |
| onTransitionCancelCapture | TransitionEventHandler<HTMLSpanElement> | — |
| onTransitionEnd | TransitionEventHandler<HTMLSpanElement> | — |
| onTransitionEndCapture | TransitionEventHandler<HTMLSpanElement> | — |
| onTransitionRun | TransitionEventHandler<HTMLSpanElement> | — |
| onTransitionRunCapture | TransitionEventHandler<HTMLSpanElement> | — |
| onTransitionStart | TransitionEventHandler<HTMLSpanElement> | — |
| onTransitionStartCapture | TransitionEventHandler<HTMLSpanElement> | — |
| onVolumeChange | ReactEventHandler<HTMLSpanElement> | — |
| onVolumeChangeCapture | ReactEventHandler<HTMLSpanElement> | — |
| onWaiting | ReactEventHandler<HTMLSpanElement> | — |
| onWaitingCapture | ReactEventHandler<HTMLSpanElement> | — |
| onWheel | WheelEventHandler<HTMLSpanElement> | — |
| onWheelCapture | WheelEventHandler<HTMLSpanElement> | — |
| onKeyPressDeprecated | KeyboardEventHandler<HTMLSpanElement> | — |
Use | ||
| onKeyPressCaptureDeprecated | KeyboardEventHandler<HTMLSpanElement> | — |
Use | ||
| Name | Type | Default |
|---|---|---|
| defaultValue | string | number | readonly string[] | — |
| Name | Type | Default |
|---|---|---|
| className | string | — |
| style | CSSProperties | — |
Combobox.List
| Name | Type | Default |
|---|---|---|
| children | ((item: T) => ReactNode) | ReactNode | — |
The contents of the collection. | ||
| dependencies | readonly any[] | — |
Values that should invalidate the item cache when using dynamic collections. | ||
| items | Iterable<T> | — |
Item objects in the collection. | ||
| renderEmptyState | ((props: ListBoxRenderProps) => ReactNode) | — |
Provides content to display when there are no items in the list. | ||
| shouldFocusOnHover | boolean | — |
Whether options should be focused when the user hovers over them. | ||
| shouldFocusWrap | boolean | — |
Whether focus should wrap around when the end/start is reached. | ||
| shouldSelectOnPressUp | boolean | — |
Whether selection should occur on press up instead of press down. | ||
| Name | Type | Default |
|---|---|---|
| aria-describedby | string | — |
Identifies the element (or elements) that describes the object. | ||
| aria-details | string | — |
Identifies the element (or elements) that provide a detailed, extended description for the object. | ||
| aria-label | string | — |
Defines a string value that labels the current element. | ||
| aria-labelledby | string | — |
Identifies the element (or elements) that labels the current element. | ||
| id | string | — |
The element's unique identifier. See MDN (opens in new tab). | ||
| Name | Type | Default |
|---|---|---|
| dir | string | — |
| hidden | boolean | — |
| inert | boolean | — |
| lang | string | — |
| render | DOMRenderFunction<"div", ListBoxRenderProps> | — |
Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements:
| ||
| slot | string | null | — |
A slot name for the component. Slots allow the component to receive props from a parent component. An explicit | ||
| suppressHydrationWarning | boolean | — |
A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs (opens in new tab). | ||
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| onAction | ((key: Key) => void) | — |
Handler that is called when a user performs an action on an item. The exact user event depends on the collection's | ||
| 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. | ||
| 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> | — |
| 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> | — |
| onSelectionChange | ((keys: Selection) => void) | — |
Handler that is called when the selection changes. | ||
| onTouchCancel | TouchEventHandler<HTMLDivElement> | — |
| onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchEnd | TouchEventHandler<HTMLDivElement> | — |
| onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchMove | TouchEventHandler<HTMLDivElement> | — |
| onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — |
| onTouchStart | TouchEventHandler<HTMLDivElement> | — |
| onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — |
| onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionRun | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionStart | TransitionEventHandler<HTMLDivElement> | — |
| onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — |
| onWheel | WheelEventHandler<HTMLDivElement> | — |
| onWheelCapture | WheelEventHandler<HTMLDivElement> | — |
| Name | Type | Default |
|---|---|---|
| className | ClassNameOrFunction<ListBoxRenderProps> | 'react-aria-ListBox' |
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state. | ||
| style | StyleOrFunction<ListBoxRenderProps> | — |
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state. | ||
Combobox.Popover
| Name | Type | Default |
|---|---|---|
| children* (required) | ReactNode | — |
The content rendered inside the popover. | ||
| arrowBoundaryOffset | number | 0 |
The minimum distance the arrow's edge should be from the edge of the overlay element. | ||
| arrowRef | RefObject<Element | null> | — |
A ref for the popover arrow element. | ||
| boundaryElement | Element | document.body |
Element that that serves as the positioning boundary. | ||
| 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. | ||
| getTargetRect | ((target: Element) => DOMRect | null) | target.getBoundingClientRect() |
Overrides the target element's bounding rectangle. Useful for positioning relative to a specific point such as the mouse cursor (e.g. context menus) or text selection. | ||
| 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. | ||
| 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. | ||
| placement | Placements | — |
The placement of the element with respect to its anchor element. | ||
| scrollRef | RefObject<Element | null> | 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. | ||
| shouldSkipAnimation | boolean | — |
Whether the popover should appear and disappear without an entry or exit animation. This is used by components such as PreviewTrigger to skip animations when quickly swapping between overlays. | ||
| shouldUpdatePosition | boolean | true |
Whether the overlay should update its position automatically. | ||
| trigger | string | — |
The name of the component that triggered the popover. This is reflected on the element as the | ||
| triggerRef | RefObject<Element | null> | — |
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 |
|---|---|---|
| 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. | ||
| Name | Type | Default |
|---|---|---|
| dir | string | — |
| hidden | boolean | — |
| inert | boolean | — |
| lang | string | — |
| 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:
| ||
| slot | string | null | — |
A slot name for the component. Slots allow the component to receive props from a parent component. An explicit | ||
| suppressHydrationWarning | boolean | — |
A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs (opens in new tab). | ||
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationStart | AnimationEventHandler<HTMLDivElement> | — |
| onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — |
| onAuxClick | MouseEventHandler<HTMLDivElement> | — |
| onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onBlurWithin | ((e: FocusEvent<Element, Element>) => void) | — |
Handler that is called when the target element and all descendants lose focus. | ||
| onClick | MouseEventHandler<HTMLDivElement> | — |
| onClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onContextMenu | MouseEventHandler<HTMLDivElement> | — |
| onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — |
| onDoubleClick | MouseEventHandler<HTMLDivElement> | — |
| onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — |
| onFocusWithin | ((e: FocusEvent<Element, Element>) => void) | — |
Handler that is called when the target element or a descendant receives focus. | ||
| onFocusWithinChange | ((isFocusWithin: boolean) => void) | — |
Handler that is called when the the focus within state changes. | ||
| onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — |
| onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — |
| onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — |
| onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — |
| onMouseDown | MouseEventHandler<HTMLDivElement> | — |
| onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseEnter | MouseEventHandler<HTMLDivElement> | — |
| onMouseLeave | MouseEventHandler<HTMLDivElement> | — |
| onMouseMove | MouseEventHandler<HTMLDivElement> | — |
| onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseOut | MouseEventHandler<HTMLDivElement> | — |
| onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseOver | MouseEventHandler<HTMLDivElement> | — |
| onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — |
| onMouseUp | MouseEventHandler<HTMLDivElement> | — |
| onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — |
| 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> | — |
| Name | Type | Default |
|---|---|---|
| className | ClassNameOrFunction<PopoverRenderProps> | 'react-aria-Popover' |
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state. | ||
| style | StyleOrFunction<PopoverRenderProps> | — |
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state. | ||
Combobox.Section
| Name | Type | Default |
|---|---|---|
| children | ((item: T) => ReactElement<unknown, string | JSXElementConstructor<any>>) | ReactNode | — |
Static child items or a function to render children. | ||
| dependencies | readonly any[] | — |
Values that should invalidate the item cache when using dynamic collections. | ||
| items | Iterable<T> | — |
Item objects in the section. | ||
| Name | Type | Default |
|---|---|---|
| aria-label | string | — |
An accessibility label for the section. | ||
| id | Key | — |
The unique id of the section. | ||
| Name | Type | Default |
|---|---|---|
| dir | string | — |
| hidden | boolean | — |
| inert | boolean | — |
| lang | string | — |
| render | DOMRenderFunction<"section", 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:
| ||
| suppressHydrationWarning | boolean | — |
A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs (opens in new tab). | ||
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| onAnimationEnd | AnimationEventHandler<HTMLElement> | — |
| onAnimationEndCapture | AnimationEventHandler<HTMLElement> | — |
| onAnimationIteration | AnimationEventHandler<HTMLElement> | — |
| onAnimationIterationCapture | AnimationEventHandler<HTMLElement> | — |
| onAnimationStart | AnimationEventHandler<HTMLElement> | — |
| onAnimationStartCapture | AnimationEventHandler<HTMLElement> | — |
| onAuxClick | MouseEventHandler<HTMLElement> | — |
| onAuxClickCapture | MouseEventHandler<HTMLElement> | — |
| onClick | MouseEventHandler<HTMLElement> | — |
| onClickCapture | MouseEventHandler<HTMLElement> | — |
| onContextMenu | MouseEventHandler<HTMLElement> | — |
| onContextMenuCapture | MouseEventHandler<HTMLElement> | — |
| onDoubleClick | MouseEventHandler<HTMLElement> | — |
| onDoubleClickCapture | MouseEventHandler<HTMLElement> | — |
| onGotPointerCapture | PointerEventHandler<HTMLElement> | — |
| onGotPointerCaptureCapture | PointerEventHandler<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> | — |
| 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> | — |
| onScroll | UIEventHandler<HTMLElement> | — |
| onScrollCapture | UIEventHandler<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> | — |
| onWheel | WheelEventHandler<HTMLElement> | — |
| onWheelCapture | WheelEventHandler<HTMLElement> | — |
| Name | Type | Default |
|---|---|---|
| value | object | — |
The object value that this section represents. When using dynamic collections, this is set automatically. | ||
| Name | Type | Default |
|---|---|---|
| className | string | 'react-aria-ListBoxSection' |
The CSS className (opens in new tab) for the element. | ||
| style | CSSProperties | — |
The inline style (opens in new tab) for the element. | ||
Combobox.SectionHeader
| Name | Type | Default |
|---|---|---|
| about | string | — |
| accessKey | string | — |
| autoSave | string | — |
| children | ReactNode | — |
| color | string | — |
| content | string | — |
| contextMenu | string | — |
| dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — |
| datatype | string | — |
| defaultChecked | boolean | — |
| exportparts | string | — |
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts (opens in new tab) | ||
| inlist | any | — |
| inputMode | "decimal" | "email" | "none" | "numeric" | "search" | "tel" | "text" | "url" | — |
Hints at the type of data that might be entered by the user while editing the element or its contents | ||
| itemID | string | — |
| itemProp | string | — |
| itemRef | string | — |
| itemScope | boolean | — |
| itemType | string | — |
| part | string | — |
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part (opens in new tab) | ||
| prefix | string | — |
| property | string | — |
| radioGroup | string | — |
| rel | string | — |
| resource | string | — |
| results | number | — |
| rev | string | — |
| security | string | — |
| title | string | — |
| typeof | string | — |
| unselectable | "off" | "on" | — |
| vocab | string | — |
| Name | Type | Default |
|---|---|---|
| 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 | "both" | "inline" | "list" | "none" | — |
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 | "false" | "mixed" | "true" | boolean | — |
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. See: aria-pressed 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 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 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 | "date" | "false" | "location" | "page" | "step" | "time" | "true" | boolean | — |
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 aria-readonly. | ||
| aria-errormessage | string | — |
Identifies the element that provides an error message for the object. See: aria-invalid 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-haspopup | "dialog" | "false" | "grid" | "listbox" | "menu" | "tree" | "true" | boolean | — |
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | ||
| aria-hidden | Booleanish | — |
Indicates whether the element is exposed to an accessibility API. See: aria-disabled. | ||
| aria-invalid | "false" | "grammar" | "spelling" | "true" | boolean | — |
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 | "assertive" | "off" | "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 | "false" | "mixed" | "true" | boolean | — |
Indicates the current "pressed" state of toggle buttons. See: aria-checked aria-selected. | ||
| aria-readonly | Booleanish | — |
Indicates that the element is not editable, but is otherwise operable. See: aria-disabled. | ||
| aria-relevant | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "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 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 aria-colspan. | ||
| aria-selected | Booleanish | — |
Indicates the current "selected" state of various widgets. See: aria-checked 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 | "ascending" | "descending" | "none" | "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. | ||
| id | string | — |
| role | AriaRole | — |
| aria-dropeffectDeprecated | "copy" | "execute" | "link" | "move" | "none" | "popup" | — |
Indicates what functions can be performed when a dragged object is released on the drop target. in ARIA 1.1 | ||
| aria-grabbedDeprecated | Booleanish | — |
Indicates an element's "grabbed" state in a drag-and-drop operation. in ARIA 1.1 | ||
| Name | Type | Default |
|---|---|---|
| autoCapitalize | "characters" | "none" | "off" | "on" | "sentences" | "words" | (string & {}) | — |
| autoCorrect | string | — |
| autoFocus | boolean | — |
| contentEditable | "inherit" | "plaintext-only" | Booleanish | — |
| dir | string | — |
| draggable | Booleanish | — |
| enterKeyHint | "done" | "enter" | "go" | "next" | "previous" | "search" | "send" | — |
| hidden | boolean | — |
| inert | boolean | — |
See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert | ||
| is | string | — |
Specify that a standard HTML element should behave like a defined custom built-in element See: https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is (opens in new tab) | ||
| lang | string | — |
| nonce | string | — |
| popover | "" | "auto" | "hint" | "manual" | — |
| popoverTarget | string | — |
| popoverTargetAction | "hide" | "show" | "toggle" | — |
| slot | string | — |
| spellCheck | Booleanish | — |
| suppressContentEditableWarning | boolean | — |
| suppressHydrationWarning | boolean | — |
| tabIndex | number | — |
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| 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> | — |
| 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> | — |
| onKeyPressDeprecated | KeyboardEventHandler<HTMLElement> | — |
Use | ||
| onKeyPressCaptureDeprecated | KeyboardEventHandler<HTMLElement> | — |
Use | ||
| Name | Type | Default |
|---|---|---|
| defaultValue | string | number | readonly string[] | — |
| Name | Type | Default |
|---|---|---|
| className | string | — |
| style | CSSProperties | — |
Combobox.Value
| Name | Type | Default |
|---|---|---|
| about | string | — |
| accessKey | string | — |
| autoSave | string | — |
| children | ChildrenOrFunction<ComboBoxValueRenderProps<T>> | — |
The children of the component. A function may be provided to alter the children based on component state. | ||
| color | string | — |
| content | string | — |
| contextMenu | string | — |
| dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — |
| datatype | string | — |
| defaultChecked | boolean | — |
| exportparts | string | — |
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts (opens in new tab) | ||
| inlist | any | — |
| inputMode | "decimal" | "email" | "none" | "numeric" | "search" | "tel" | "text" | "url" | — |
Hints at the type of data that might be entered by the user while editing the element or its contents | ||
| itemID | string | — |
| itemProp | string | — |
| itemRef | string | — |
| itemScope | boolean | — |
| itemType | string | — |
| part | string | — |
See: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part (opens in new tab) | ||
| prefix | string | — |
| property | string | — |
| radioGroup | string | — |
| rel | string | — |
| resource | string | — |
| results | number | — |
| rev | string | — |
| security | string | — |
| title | string | — |
| typeof | string | — |
| unselectable | "off" | "on" | — |
| vocab | string | — |
| Name | Type | Default |
|---|---|---|
| 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 | "both" | "inline" | "list" | "none" | — |
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 | "false" | "mixed" | "true" | boolean | — |
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. See: aria-pressed 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 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 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 | "date" | "false" | "location" | "page" | "step" | "time" | "true" | boolean | — |
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 aria-readonly. | ||
| aria-errormessage | string | — |
Identifies the element that provides an error message for the object. See: aria-invalid 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-haspopup | "dialog" | "false" | "grid" | "listbox" | "menu" | "tree" | "true" | boolean | — |
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. | ||
| aria-hidden | Booleanish | — |
Indicates whether the element is exposed to an accessibility API. See: aria-disabled. | ||
| aria-invalid | "false" | "grammar" | "spelling" | "true" | boolean | — |
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 | "assertive" | "off" | "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 | "false" | "mixed" | "true" | boolean | — |
Indicates the current "pressed" state of toggle buttons. See: aria-checked aria-selected. | ||
| aria-readonly | Booleanish | — |
Indicates that the element is not editable, but is otherwise operable. See: aria-disabled. | ||
| aria-relevant | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "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 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 aria-colspan. | ||
| aria-selected | Booleanish | — |
Indicates the current "selected" state of various widgets. See: aria-checked 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 | "ascending" | "descending" | "none" | "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. | ||
| id | string | — |
| role | AriaRole | — |
| aria-dropeffectDeprecated | "copy" | "execute" | "link" | "move" | "none" | "popup" | — |
Indicates what functions can be performed when a dragged object is released on the drop target. in ARIA 1.1 | ||
| aria-grabbedDeprecated | Booleanish | — |
Indicates an element's "grabbed" state in a drag-and-drop operation. in ARIA 1.1 | ||
| Name | Type | Default |
|---|---|---|
| autoCapitalize | "characters" | "none" | "off" | "on" | "sentences" | "words" | (string & {}) | — |
| autoCorrect | string | — |
| autoFocus | boolean | — |
| contentEditable | "inherit" | "plaintext-only" | Booleanish | — |
| dir | string | — |
| draggable | Booleanish | — |
| enterKeyHint | "done" | "enter" | "go" | "next" | "previous" | "search" | "send" | — |
| hidden | boolean | — |
| inert | boolean | — |
See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert | ||
| is | string | — |
Specify that a standard HTML element should behave like a defined custom built-in element See: https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is (opens in new tab) | ||
| key | Key | null | — |
| lang | string | — |
| nonce | string | — |
| popover | "" | "auto" | "hint" | "manual" | — |
| popoverTarget | string | — |
| popoverTargetAction | "hide" | "show" | "toggle" | — |
| ref | Ref<HTMLDivElement> | — |
Allows getting a ref to the component instance. Once the component unmounts, React will set | ||
| render | DOMRenderFunction<"div", ComboBoxValueRenderProps<T>> | — |
Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements:
| ||
| slot | string | — |
| spellCheck | Booleanish | — |
| suppressContentEditableWarning | boolean | — |
| suppressHydrationWarning | boolean | — |
| tabIndex | number | — |
| translate | "no" | "yes" | — |
| Name | Type | Default |
|---|---|---|
| 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> | — |
| 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> | — |
| onKeyPressDeprecated | KeyboardEventHandler<HTMLElement> | — |
Use | ||
| onKeyPressCaptureDeprecated | KeyboardEventHandler<HTMLElement> | — |
Use | ||
| Name | Type | Default |
|---|---|---|
| defaultValue | string | number | readonly string[] | — |
| placeholder | ReactNode | — |
A value to display when no items are selected. | ||
| Name | Type | Default |
|---|---|---|
| className | ClassNameOrFunction<ComboBoxValueRenderProps<T>> | 'react-aria-ComboBoxValue' |
The CSS className (opens in new tab) for the element. A function may be provided to compute the class based on component state. | ||
| style | StyleOrFunction<ComboBoxValueRenderProps<T>> | — |
The inline style (opens in new tab) for the element. A function may be provided to compute the style based on component state. | ||