Skip to main content

useFocusTrap

Datalayer Core


Datalayer Core / useFocusTrap

Function: useFocusTrap()

useFocusTrap(settings?, dependencies?): object

Defined in: tech/datalayer/core/src/hooks/useFocusTrap.ts:38

Hook used to trap focus inside a container. Returns a ref that can be added to the container that should trap focus.

Parameters​

settings?​

FocusTrapHookSettings

{FocusTrapHookSettings}

dependencies?​

DependencyList = []

Returns​

object

containerRef​

containerRef: undefined | RefObject<HTMLElement>

initialFocusRef​

initialFocusRef: undefined | RefObject<HTMLElement>