/
index.ts
123 lines (105 loc) · 2.84 KB
/
index.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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
import { MaybeElementRef, unrefElement, tryOnUnmounted, Fn } from '@vueuse/core'
import { watch, ref, Ref } from 'vue-demi'
import { ActivateOptions, createFocusTrap, DeactivateOptions, FocusTrap, Options } from 'focus-trap'
export interface UseFocusTrapOptions extends Options {
/**
* Immediately activate the trap
*/
immediate?: boolean
}
export interface UseFocusTrapReturn {
/**
* Indicates if the focus trap is currently active
*/
hasFocus: Ref<boolean>
/**
* Indicates if the focus trap is currently paused
*/
isPaused: Ref<boolean>
/**
* Activate the focus trap
*
* @link https://github.com/focus-trap/focus-trap#trapactivateactivateoptions
* @param opts Activate focus trap options
*/
activate: (opts?: ActivateOptions) => void
/**
* Deactivate the focus trap
*
* @link https://github.com/focus-trap/focus-trap#trapdeactivatedeactivateoptions
* @param opts Deactivate focus trap options
*/
deactivate: (opts?: DeactivateOptions) => void
/**
* Pause the focus trap
*
* @link https://github.com/focus-trap/focus-trap#trappause
*/
pause: Fn
/**
* Unpauses the focus trap
*
* @link https://github.com/focus-trap/focus-trap#trapunpause
*/
unpause: Fn
}
/**
* Reactive focus-trap
*
* @link https://vueuse.org/useFocusTrap
* @param target The target element to trap focus within
* @param options Focus trap options
* @param autoFocus Focus trap automatically when mounted
*/
export function useFocusTrap(target: MaybeElementRef, options: UseFocusTrapOptions = {}): UseFocusTrapReturn {
let trap: undefined | FocusTrap
const { immediate, ...focusTrapOptions } = options
const hasFocus = ref(false)
const isPaused = ref(false)
const activate = (opts?: ActivateOptions) => trap && trap.activate(opts)
const deactivate = (opts?: DeactivateOptions) => trap && trap.deactivate(opts)
const pause = () => {
if (trap) {
trap.pause()
isPaused.value = true
}
}
const unpause = () => {
if (trap) {
trap.unpause()
isPaused.value = false
}
}
watch(
() => unrefElement(target),
(el: HTMLElement) => {
trap = createFocusTrap(el, {
...focusTrapOptions,
onActivate() {
hasFocus.value = true
// Apply if user provided onActivate option
if (options.onActivate)
options.onActivate()
},
onDeactivate() {
hasFocus.value = false
// Apply if user provided onDeactivate option
if (options.onDeactivate)
options.onDeactivate()
},
})
// Focus if immediate is set to true
if (immediate)
activate()
}, { flush: 'post' })
// Cleanup on unmount
tryOnUnmounted(() => deactivate())
return {
hasFocus,
isPaused,
activate,
deactivate,
pause,
unpause,
}
}