/
useFocusTrap.ts
101 lines (87 loc) · 2.29 KB
/
useFocusTrap.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
import { RefObject, useEffect, useMemo, useRef } from 'react'
import { useIsomorphicLayoutEffect as useLayoutEffect } from '../isomorphic-layout-effect'
import { createFocusTrap } from './FocusTrap'
import { FocusTrapInstance, FocusTrapOptions } from './types'
import { useRestoreFocus } from './useRestoreFocus'
export interface UseFocusTrapProps {
/**
* Ref-container with dom-node for focus trap.
*/
scopeRef: RefObject<HTMLElement>
/**
* Enables focus trap.
*/
enabled: boolean | undefined
/**
* Returns focus in trigger after disabling trap.
*
* @default true
*/
restoreFocus?: boolean
/**
* Ref-container with dom-node uses for restore focus after disabling trap.
*/
restoreFocusRef?: RefObject<HTMLElement>
/**
* Sets focus in first focusable element inside trap.
*
* @default true
*/
autoFocus?: boolean
}
/**
* Creates focus trap for selected dom-node.
*
* @example
* const Modal = (props) => {
* const { isVisible, children } = props
* const scopeRef = useRef(null)
*
* useFocusTrap({ enabled: isVisible, scopeRef })
*
* return (
* <div ref={scopeRef}>{children}</div>
* )
* }
*/
export function useFocusTrap(props: UseFocusTrapProps) {
const { scopeRef, enabled, restoreFocusRef, restoreFocus = true, autoFocus = true } = props
const instance = useRef<FocusTrapInstance | null>(null)
const ref = useRef<HTMLElement | null>(null)
const trapOptions = useMemo<FocusTrapOptions>(() => {
return {
autoFocus,
}
}, [autoFocus])
useEffect(() => {
if (instance.current) {
instance.current.setOptions(trapOptions)
}
}, [trapOptions])
useLayoutEffect(() => {
if (ref.current === scopeRef.current) {
return
}
ref.current = scopeRef.current
if (instance.current) {
instance.current.deactivate()
instance.current = null
}
if (ref.current) {
instance.current = createFocusTrap(ref.current, trapOptions)
if (enabled) {
instance.current.activate()
}
}
})
useLayoutEffect(() => {
if (!enabled || !instance.current) {
return
}
instance.current.activate()
return () => {
instance.current?.deactivate()
}
}, [enabled])
useRestoreFocus({ enabled: enabled && restoreFocus, restoreFocusRef })
}