Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Optional aria-atomic
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.
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.
Optional aria-busy
aria-busy?:Booleanish
Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
Indicates what functions can be performed when a dragged object is released on the drop target.
deprecated
in ARIA 1.1
Optional aria-errormessage
aria-errormessage?:string
Identifies the element that provides an error message for the object.
see
aria-invalid @see aria-describedby.
Optional aria-expanded
aria-expanded?:Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Optional aria-flowto
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.
Optional aria-grabbed
aria-grabbed?:Booleanish
Indicates an element's "grabbed" state in a drag-and-drop operation.
Indicates the entered value does not conform to the format expected by the application.
see
aria-errormessage.
Optional aria-keyshortcuts
aria-keyshortcuts?:string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Optional aria-label
aria-label?:string
Defines a string value that labels the current element.
see
aria-labelledby.
Optional aria-labelledby
aria-labelledby?:string
Identifies the element (or elements) that labels the current element.
see
aria-describedby.
Optional aria-level
aria-level?:number
Defines the hierarchical level of an element within a structure.
Optional aria-live
aria-live?:"off" | "assertive" | "polite"
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
Optional aria-modal
aria-modal?:Booleanish
Indicates whether an element is modal when displayed.
Optional aria-multiline
aria-multiline?:Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
Optional aria-multiselectable
aria-multiselectable?:Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
Optional aria-orientation
aria-orientation?:"horizontal" | "vertical"
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Optional aria-owns
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.
Optional aria-placeholder
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.
Optional aria-posinset
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.
Indicates if items in a table or grid are sorted in ascending or descending order.
Optional aria-valuemax
aria-valuemax?:number
Defines the maximum allowed value for a range widget.
Optional aria-valuemin
aria-valuemin?:number
Defines the minimum allowed value for a range widget.
Optional aria-valuenow
aria-valuenow?:number
Defines the current value for a range widget.
see
aria-valuetext.
Optional aria-valuetext
aria-valuetext?:string
Defines the human readable text alternative of aria-valuenow for a range widget.
Optional autoCapitalize
autoCapitalize?:string
Optional autoCorrect
autoCorrect?:string
Optional autoSave
autoSave?:string
Optional children
children?:ReactNode
Optional className
className?:string
Optional classNames
classNames?:CSSTransitionClassNames
{@inheritDoc CSSTransitionClassNames}
Optional color
color?:string
Optional contentEditable
contentEditable?:Booleanish | "inherit"
Optional contextMenu
contextMenu?:string
Optional dangerouslySetInnerHTML
dangerouslySetInnerHTML?:{ __html: string }
Type declaration
__html: string
Optional datatype
datatype?:string
Optional defaultChecked
defaultChecked?:boolean
Optional dir
dir?:string
Optional disableMovementChange
disableMovementChange?:boolean
Boolean if using the keyboard should not immediately trigger the onChange
callback. When this is enabled, the onChange callback will only be called
if the user clicks an item or presses the enter or space key.
The default way to generate a "unique" id for each option within the listbox
by concatenating the current index with a base id.
Note: The index will be incremented by 1 so the ids start from 1 instead of
0. This is so that it matches how paginated results work with aria-posinset
A function that will get the label for an option. The default behavior is to
check if the option is an object. If it is, it'll use the labelKey property
and fallback to the children property. If it is anything else, the option
itself will be returned.
This is used in both the select's button element to show the current value as
well as rendering each option within the listbox component.
The default implementation of the getItemValue search option that will
attempt to "stringify" any unknown item as a string.
internal
Parameters
item: unknown
The current item to transform
Optional valueKey: string
The key to use that should hold the value if the item is an
object
Returns string
the item as a string
Optional hidden
hidden?:boolean
id
id:string
The id for the listbox. This is required for a11y and is used to generate
unique ids for each option within the listbox for aria-activedescendant
movement.
A key to use that extracts the display label for an option from the options
list. This will only be used if the option is an object and is passed to
the getOptionLabel prop.
Optional lang
lang?:string
Optional name
name?:string
An optional name to provide for the listbox that will be provided with the
onChange callback.
Boolean if all the options should just be read only and prevent the
onChange handler to be called when an option is keyboard focused or
clicked.
Optional resource
resource?:string
Optional results
results?:number
Optional role
role?:AriaRole
Optional security
security?:string
Optional slot
slot?:string
Optional spellCheck
spellCheck?:Booleanish
Optional style
style?:CSSProperties
Optional suppressContentEditableWarning
suppressContentEditableWarning?:boolean
Optional suppressHydrationWarning
suppressHydrationWarning?:boolean
Optional tabIndex
tabIndex?:number
Optional temporary
temporary?:boolean
Boolean if the listbox is in a temporary element (like a dropdown). This
will update the behavior so that the default tabIndex is -1 instead of
0 since it shouldn't be tab focusable within a dropdown.
Optional timeout
timeout?:TransitionTimeout
{@inheritDoc TransitionTimeout}
Optional title
title?:string
Optional translate
translate?:"yes" | "no"
Optional typeof
typeof?:string
Optional unselectable
unselectable?:"on" | "off"
value
value:string
The listbox is a controlled component, so you will need to provide the
current value and an onChange handler. The value must be a string and
should be one of the option's values when something has been selected. If
you want to have an "empty" select box to require the user to manually
select something to be considered valid, you can set this to the empty
string and it'll be considered "unvalued".
Optional valueKey
valueKey?:string
A key to use that extracts the value for the option from the options list.
This will only be used if the option is an object and will be passed to the
getOptionValue prop.
Optional visible
visible?:boolean
Boolean if the listbox is visible. This should stay defaulted as true
when the temporary prop is set to false.
A function to call for each option to check if it is currently disabled.
This is really just a convenience prop so that you don't need to modify the
options yourself.
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.