• Public
  • Public/Protected
  • All

Interface FocusContainerProps





about?: string
accessKey?: string
aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

aria-autocomplete?: "list" | "none" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

aria-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.

aria-checked?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.


aria-pressed @see aria-selected.

aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.



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.


aria-colcount @see aria-colspan.

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.


aria-colindex @see aria-rowspan.

aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.



aria-current?: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

Indicates the element that represents the current item within a container or set of related elements.

aria-describedby?: string

Identifies the element (or elements) that describes the object.



aria-details?: string

Identifies the element that provides a detailed, extended description for the object.



aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.


aria-hidden @see aria-readonly.

aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.


in ARIA 1.1

aria-errormessage?: string

Identifies the element that provides an error message for the object.


aria-invalid @see aria-describedby.

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.


in ARIA 1.1

aria-haspopup?: boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.



aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.



aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

aria-label?: string

Defines a string value that labels the current element.



aria-labelledby?: string

Identifies the element (or elements) that labels the current element.



aria-level?: number

Defines the hierarchical level of an element within a structure.

aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.



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.



aria-pressed?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.


aria-checked @see aria-selected.

aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.



aria-relevant?: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.



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.



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.


aria-rowcount @see aria-rowspan.

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.


aria-rowindex @see aria-colspan.

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.


aria-checked @see aria-pressed.

aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.



aria-sort?: "none" | "ascending" | "descending" | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

aria-valuenow?: number

Defines the current value for a range widget.



aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

autoCapitalize?: string
autoCorrect?: string
autoSave?: string
children?: ReactNode
className?: string
color?: string
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.

contentEditable?: Booleanish | "inherit"
contextMenu?: string
dangerouslySetInnerHTML?: { __html: string }

Type declaration

  • __html: string
datatype?: string
defaultChecked?: boolean
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.

defaultValue?: string | number | readonly string[]
dir?: string
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.

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.

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.

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.

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).

draggable?: Booleanish
hidden?: boolean
id?: string
inlist?: any
inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents



is?: string

Specify that a standard HTML element should behave like a defined custom built-in element



itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
lang?: string
onAbort?: ReactEventHandler<HTMLElement>
onAbortCapture?: ReactEventHandler<HTMLElement>
onAnimationEnd?: AnimationEventHandler<HTMLElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLElement>
onAnimationIteration?: AnimationEventHandler<HTMLElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>
onAnimationStart?: AnimationEventHandler<HTMLElement>
onAnimationStartCapture?: AnimationEventHandler<HTMLElement>
onAuxClick?: MouseEventHandler<HTMLElement>
onAuxClickCapture?: MouseEventHandler<HTMLElement>
onBeforeInput?: FormEventHandler<HTMLElement>
onBeforeInputCapture?: FormEventHandler<HTMLElement>
onBlur?: FocusEventHandler<HTMLElement>
onBlurCapture?: FocusEventHandler<HTMLElement>
onCanPlay?: ReactEventHandler<HTMLElement>
onCanPlayCapture?: ReactEventHandler<HTMLElement>
onCanPlayThrough?: ReactEventHandler<HTMLElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLElement>
onChange?: FormEventHandler<HTMLElement>
onChangeCapture?: FormEventHandler<HTMLElement>
onClick?: MouseEventHandler<HTMLElement>
onClickCapture?: MouseEventHandler<HTMLElement>
onCompositionEnd?: CompositionEventHandler<HTMLElement>
onCompositionEndCapture?: CompositionEventHandler<HTMLElement>
onCompositionStart?: CompositionEventHandler<HTMLElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLElement>
onCompositionUpdate?: CompositionEventHandler<HTMLElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLElement>
onContextMenu?: MouseEventHandler<HTMLElement>
onContextMenuCapture?: MouseEventHandler<HTMLElement>
onCopy?: ClipboardEventHandler<HTMLElement>
onCopyCapture?: ClipboardEventHandler<HTMLElement>
onCut?: ClipboardEventHandler<HTMLElement>
onCutCapture?: ClipboardEventHandler<HTMLElement>
onDoubleClick?: MouseEventHandler<HTMLElement>
onDoubleClickCapture?: MouseEventHandler<HTMLElement>
onDrag?: DragEventHandler<HTMLElement>
onDragCapture?: DragEventHandler<HTMLElement>
onDragEnd?: DragEventHandler<HTMLElement>
onDragEndCapture?: DragEventHandler<HTMLElement>
onDragEnter?: DragEventHandler<HTMLElement>
onDragEnterCapture?: DragEventHandler<HTMLElement>
onDragExit?: DragEventHandler<HTMLElement>
onDragExitCapture?: DragEventHandler<HTMLElement>
onDragLeave?: DragEventHandler<HTMLElement>
onDragLeaveCapture?: DragEventHandler<HTMLElement>
onDragOver?: DragEventHandler<HTMLElement>
onDragOverCapture?: DragEventHandler<HTMLElement>
onDragStart?: DragEventHandler<HTMLElement>
onDragStartCapture?: DragEventHandler<HTMLElement>
onDrop?: DragEventHandler<HTMLElement>
onDropCapture?: DragEventHandler<HTMLElement>
onDurationChange?: ReactEventHandler<HTMLElement>
onDurationChangeCapture?: ReactEventHandler<HTMLElement>
onEmptied?: ReactEventHandler<HTMLElement>
onEmptiedCapture?: ReactEventHandler<HTMLElement>
onEncrypted?: ReactEventHandler<HTMLElement>
onEncryptedCapture?: ReactEventHandler<HTMLElement>
onEnded?: ReactEventHandler<HTMLElement>
onEndedCapture?: ReactEventHandler<HTMLElement>
onError?: ReactEventHandler<HTMLElement>
onErrorCapture?: ReactEventHandler<HTMLElement>
onFocus?: FocusEventHandler<HTMLElement>
onFocusCapture?: FocusEventHandler<HTMLElement>
onGotPointerCapture?: PointerEventHandler<HTMLElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>
onInput?: FormEventHandler<HTMLElement>
onInputCapture?: FormEventHandler<HTMLElement>
onInvalid?: FormEventHandler<HTMLElement>
onInvalidCapture?: FormEventHandler<HTMLElement>
onKeyDown?: KeyboardEventHandler<HTMLElement>
onKeyDownCapture?: KeyboardEventHandler<HTMLElement>
onKeyPress?: KeyboardEventHandler<HTMLElement>
onKeyPressCapture?: KeyboardEventHandler<HTMLElement>
onKeyUp?: KeyboardEventHandler<HTMLElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLElement>
onLoad?: ReactEventHandler<HTMLElement>
onLoadCapture?: ReactEventHandler<HTMLElement>
onLoadStart?: ReactEventHandler<HTMLElement>
onLoadStartCapture?: ReactEventHandler<HTMLElement>
onLoadedData?: ReactEventHandler<HTMLElement>
onLoadedDataCapture?: ReactEventHandler<HTMLElement>
onLoadedMetadata?: ReactEventHandler<HTMLElement>
onLoadedMetadataCapture?: 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>
onPointerEnterCapture?: PointerEventHandler<HTMLElement>
onPointerLeave?: PointerEventHandler<HTMLElement>
onPointerLeaveCapture?: 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>
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>
onTouchCancel?: TouchEventHandler<HTMLElement>
onTouchCancelCapture?: TouchEventHandler<HTMLElement>
onTouchEnd?: TouchEventHandler<HTMLElement>
onTouchEndCapture?: TouchEventHandler<HTMLElement>
onTouchMove?: TouchEventHandler<HTMLElement>
onTouchMoveCapture?: TouchEventHandler<HTMLElement>
onTouchStart?: TouchEventHandler<HTMLElement>
onTouchStartCapture?: TouchEventHandler<HTMLElement>
onTransitionEnd?: TransitionEventHandler<HTMLElement>
onTransitionEndCapture?: TransitionEventHandler<HTMLElement>
onVolumeChange?: ReactEventHandler<HTMLElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLElement>
onWaiting?: ReactEventHandler<HTMLElement>
onWaitingCapture?: ReactEventHandler<HTMLElement>
onWheel?: WheelEventHandler<HTMLElement>
onWheelCapture?: WheelEventHandler<HTMLElement>
placeholder?: string
prefix?: string
property?: string
radioGroup?: string
resource?: string
results?: number
role?: AriaRole
security?: string
slot?: string
spellCheck?: Booleanish
style?: CSSProperties
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex?: number
title?: string
translate?: "yes" | "no"
typeof?: string
unmountFocusFallback?: FocusFallback

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.

unselectable?: "on" | "off"
vocab?: string

Generated using TypeDoc