-
Notifications
You must be signed in to change notification settings - Fork 1k
/
portal.tsx
267 lines (221 loc) · 7.24 KB
/
portal.tsx
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
'use client'
import React, {
Fragment,
createContext,
useContext,
useEffect,
useMemo,
useRef,
useState,
type ContextType,
type ElementType,
type MutableRefObject,
type Ref,
} from 'react'
import { createPortal } from 'react-dom'
import { useEvent } from '../../hooks/use-event'
import { useIsoMorphicEffect } from '../../hooks/use-iso-morphic-effect'
import { useOnUnmount } from '../../hooks/use-on-unmount'
import { useOwnerDocument } from '../../hooks/use-owner'
import { useServerHandoffComplete } from '../../hooks/use-server-handoff-complete'
import { optionalRef, useSyncRefs } from '../../hooks/use-sync-refs'
import { usePortalRoot } from '../../internal/portal-force-root'
import type { Props } from '../../types'
import { env } from '../../utils/env'
import { forwardRefWithAs, render, type HasDisplayName, type RefProp } from '../../utils/render'
function usePortalTarget(ref: MutableRefObject<HTMLElement | null>): HTMLElement | null {
let forceInRoot = usePortalRoot()
let groupTarget = useContext(PortalGroupContext)
let ownerDocument = useOwnerDocument(ref)
let [target, setTarget] = useState(() => {
// Group context is used, but still null
if (!forceInRoot && groupTarget !== null) return groupTarget.current ?? null
// No group context is used, let's create a default portal root
if (env.isServer) return null
let existingRoot = ownerDocument?.getElementById('headlessui-portal-root')
if (existingRoot) return existingRoot
if (ownerDocument === null) return null
let root = ownerDocument.createElement('div')
root.setAttribute('id', 'headlessui-portal-root')
return ownerDocument.body.appendChild(root)
})
// Ensure the portal root is always in the DOM
useEffect(() => {
if (target === null) return
if (!ownerDocument?.body.contains(target)) {
ownerDocument?.body.appendChild(target)
}
}, [target, ownerDocument])
useEffect(() => {
if (forceInRoot) return
if (groupTarget === null) return
setTarget(groupTarget.current)
}, [groupTarget, setTarget, forceInRoot])
return target
}
// ---
let DEFAULT_PORTAL_TAG = Fragment
type PortalRenderPropArg = {}
type PortalPropsWeControl = never
export type PortalProps<TTag extends ElementType = typeof DEFAULT_PORTAL_TAG> = Props<
TTag,
PortalRenderPropArg,
PortalPropsWeControl,
{
enabled?: boolean
}
>
let InternalPortalFn = forwardRefWithAs(function InternalPortalFn<
TTag extends ElementType = typeof DEFAULT_PORTAL_TAG,
>(props: PortalProps<TTag>, ref: Ref<HTMLElement>) {
let theirProps = props
let internalPortalRootRef = useRef<HTMLElement | null>(null)
let portalRef = useSyncRefs(
optionalRef<(typeof internalPortalRootRef)['current']>((ref) => {
internalPortalRootRef.current = ref
}),
ref
)
let ownerDocument = useOwnerDocument(internalPortalRootRef)
let target = usePortalTarget(internalPortalRootRef)
let [element] = useState<HTMLDivElement | null>(() =>
env.isServer ? null : ownerDocument?.createElement('div') ?? null
)
let parent = useContext(PortalParentContext)
let ready = useServerHandoffComplete()
useIsoMorphicEffect(() => {
if (!target || !element) return
// Element already exists in target, always calling target.appendChild(element) will cause a
// brief unmount/remount.
if (!target.contains(element)) {
element.setAttribute('data-headlessui-portal', '')
target.appendChild(element)
}
}, [target, element])
useIsoMorphicEffect(() => {
if (!element) return
if (!parent) return
return parent.register(element)
}, [parent, element])
useOnUnmount(() => {
if (!target || !element) return
if (element instanceof Node && target.contains(element)) {
target.removeChild(element)
}
if (target.childNodes.length <= 0) {
target.parentElement?.removeChild(target)
}
})
if (!ready) return null
let ourProps = { ref: portalRef }
return !target || !element
? null
: createPortal(
render({
ourProps,
theirProps,
slot: {},
defaultTag: DEFAULT_PORTAL_TAG,
name: 'Portal',
}),
element
)
})
function PortalFn<TTag extends ElementType = typeof DEFAULT_PORTAL_TAG>(
props: PortalProps<TTag>,
ref: Ref<HTMLElement>
) {
let portalRef = useSyncRefs(ref)
let { enabled = true, ...theirProps } = props
return enabled ? (
<InternalPortalFn {...theirProps} ref={portalRef} />
) : (
render({
ourProps: { ref: portalRef },
theirProps,
slot: {},
defaultTag: DEFAULT_PORTAL_TAG,
name: 'Portal',
})
)
}
// ---
let DEFAULT_GROUP_TAG = Fragment
type GroupRenderPropArg = {}
type GroupPropsWeControl = never
let PortalGroupContext = createContext<MutableRefObject<HTMLElement | null> | null>(null)
export type PortalGroupProps<TTag extends ElementType = typeof DEFAULT_GROUP_TAG> = Props<
TTag,
GroupRenderPropArg,
GroupPropsWeControl,
{
target: MutableRefObject<HTMLElement | null>
}
>
function GroupFn<TTag extends ElementType = typeof DEFAULT_GROUP_TAG>(
props: PortalGroupProps<TTag>,
ref: Ref<HTMLElement>
) {
let { target, ...theirProps } = props
let groupRef = useSyncRefs(ref)
let ourProps = { ref: groupRef }
return (
<PortalGroupContext.Provider value={target}>
{render({
ourProps,
theirProps,
defaultTag: DEFAULT_GROUP_TAG,
name: 'Popover.Group',
})}
</PortalGroupContext.Provider>
)
}
// ---
let PortalParentContext = createContext<{
register: (portal: HTMLElement) => () => void
unregister: (portal: HTMLElement) => void
portals: MutableRefObject<HTMLElement[]>
} | null>(null)
export function useNestedPortals() {
let parent = useContext(PortalParentContext)
let portals = useRef<HTMLElement[]>([])
let register = useEvent((portal: HTMLElement) => {
portals.current.push(portal)
if (parent) parent.register(portal)
return () => unregister(portal)
})
let unregister = useEvent((portal: HTMLElement) => {
let idx = portals.current.indexOf(portal)
if (idx !== -1) portals.current.splice(idx, 1)
if (parent) parent.unregister(portal)
})
let api = useMemo<ContextType<typeof PortalParentContext>>(
() => ({ register, unregister, portals }),
[register, unregister, portals]
)
return [
portals,
useMemo(() => {
return function PortalWrapper({ children }: { children: React.ReactNode }) {
return <PortalParentContext.Provider value={api}>{children}</PortalParentContext.Provider>
}
}, [api]),
] as const
}
// ---
export interface _internal_ComponentPortal extends HasDisplayName {
<TTag extends ElementType = typeof DEFAULT_PORTAL_TAG>(
props: PortalProps<TTag> & RefProp<typeof PortalFn>
): JSX.Element
}
export interface _internal_ComponentPortalGroup extends HasDisplayName {
<TTag extends ElementType = typeof DEFAULT_GROUP_TAG>(
props: PortalGroupProps<TTag> & RefProp<typeof GroupFn>
): JSX.Element
}
let PortalRoot = forwardRefWithAs(PortalFn) as unknown as _internal_ComponentPortal
export let PortalGroup = forwardRefWithAs(GroupFn) as _internal_ComponentPortalGroup
export let Portal = Object.assign(PortalRoot, {
/** @deprecated use `<PortalGroup>` instead of `<Portal.Group>` */
Group: PortalGroup,
})