autoFocus
Description
If true, the first focusable element within the children will auto-focused once FocusLock mounts.
Type
booleanDefault
falseFocusLock
FocusLock is a component that improves accessibility by restricting focus within elements such as modals and dialogs, and locking the focus within that range.
Props
FocusLockProps
contentRef
Description
The ref of the wrapper for which the focus-lock wraps.
Type
RefObject<HTMLElement>disabled
Description
If true, focus trapping will be disabled.
Type
booleanDefault
falsefinalFocusRef
Description
ref of the element to return focus to when FocusLock unmounts.
Type
RefObject<FocusableElement>initialFocusRef
Description
ref of the element to receive focus initially.
Type
RefObject<FocusableElement>isDisabled
DeprecatedDescription
If true, focus trapping will be disabled.
Deprecated
Use disabled instead.
Type
booleanDefault
falselockFocusAcrossFrames
Description
Enables aggressive focus capturing within iframes.
- If true: keep focus in the lock, no matter where lock is active.
- If false: allows focus to move outside of iframe.
Type
booleanDefault
falsepersistentFocus
Description
If true, disables text selections inside, and outside focus lock.
Type
booleanDefault
falserestoreFocus
Description
If true, focus will be restored to the element that triggered the FocusLock once it unmounts.
Type
booleanDefault
falseEdit this page on GitHub