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 color
color?:string
Optional component
component?:ElementType<any>
The component to render the focus container as. This should really not be
used as it is more for internal usage. The only base requirements for this
prop is that it must either be a element string ("div", "span", etc) or
a custom component that has forwarded the ref to the DOM node.
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 defaultFocus
defaultFocus?:string
This is the element that should be focused by default when the component is
mounted. This can either be the first or last focusable item or a query
selector string that is run against this component to focus.
Optional defaultValue
defaultValue?:string | number | readonly string[]
Optional dir
dir?:string
Optional disableFocusCache
disableFocusCache?:boolean
By default, the focus container will try to maintain a cache of the
focusable elements that is updated only when this component re-renders. If
the children are extremely dynamic and focusable elements can be
removed/added without this component updating, you should disable the cache
so that the focusable elements are updated each time the tab key is
pressed. Disabling the cache will be slightly slower for larger focusable
areas, but it might not be too bad.
NOTE: The only important elements are the first and last elements in
this list. So if your children aren't changing the first and last
elements, there's no need to disable the cache.
Optional disableFocusOnMount
disableFocusOnMount?:boolean
The default behavior for the focus container is to focus an element once it
is mounted and the disabled prop is not enabled. This behavior can be
disabled if this is not wanted for some reason.
Optional disableFocusOnMountScroll
disableFocusOnMountScroll?:boolean
Boolean if the element that gets focused on mount should try to not scroll
the focused element into view which is the default behavior. This should
normally remain false, but it is useful to set to true if the
FocusContainer is within a transition that appears offscreen.
Optional disableFocusOnUnmount
disableFocusOnUnmount?:boolean
The default behavior for the focus container is to attempt to focus the
element that was focused before the focus container was mounted since it is
generally used for temporary material. If there are cases where this
behavior is not wanted, you can enable this prop.
Optional disableTabFocusWrap
disableTabFocusWrap?:boolean
Boolean if the focus behavior should be disabled. This should really be
used if you are using nested focus containers for temporary material (such
as dialogs or menus).
When the focus container unmounts, it will attempt to re-focus the element
that was focused before the focus container was mounted unless the
disableFocusOnUnmount prop is enabled. There might be cases where
unmounting the focus container causes the page to re-render and the
previous element no longer exists. When this happens keyboard users might
have a problem navigating through the page again depending on how the
browser implemented the native tab behavior so this prop allows you to
ensure that a specific element is focused in these cases.
This can either be a query selector string, a specific HTMLElement, or a
function that finds a specific HTMLElement to focus.
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.