FocusTrapProps

external interface FocusTrapProps : PropsWithChildren(source)

Properties

abstract override var children: ReactNode?

A single child content element.

If true, the focus trap will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any focus trap children that have the disableAutoFocus prop.

disableEnforceFocus

abstract var disableEnforceFocus: Boolean?

If true, the focus trap will not prevent focus from leaving the focus trap while open.

disableRestoreFocus

abstract var disableRestoreFocus: Boolean?

If true, the focus trap will not restore focus to previously focused element once focus trap is hidden or unmounted.

getTabbable

abstract var getTabbable: (root: HTMLElement) -> ReadonlyArray<String>?

Returns an array of ordered tabbable nodes (i.e. in tab order) within the root. For instance, you can provide the "tabbable" npm dependency.

isEnabled

abstract var isEnabled: () -> Boolean?

This prop extends the open prop. It allows to toggle the open state without having to wait for a rerender when changing the open prop. This prop should be memoized. It can be used to support multiple focus trap mounted at the same time.

key

abstract var key: Key?

open

abstract var open: Boolean

If true, focus is locked.