/
portal.tsx
167 lines (133 loc) · 4.48 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
import React, {
Fragment,
createContext,
useContext,
useEffect,
useRef,
useState,
// Types
ElementType,
MutableRefObject,
Ref,
} from 'react'
import { createPortal } from 'react-dom'
import { Props } from '../../types'
import { forwardRefWithAs, render } from '../../utils/render'
import { useIsoMorphicEffect } from '../../hooks/use-iso-morphic-effect'
import { usePortalRoot } from '../../internal/portal-force-root'
import { useServerHandoffComplete } from '../../hooks/use-server-handoff-complete'
import { optionalRef, useSyncRefs } from '../../hooks/use-sync-refs'
import { useOwnerDocument } from '../../hooks/use-owner'
import { microTask } from '../../utils/micro-task'
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 null
// No group context is used, let's create a default portal root
if (typeof window === 'undefined') 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
interface PortalRenderPropArg {}
let PortalRoot = forwardRefWithAs(function Portal<
TTag extends ElementType = typeof DEFAULT_PORTAL_TAG
>(props: Props<TTag, PortalRenderPropArg>, 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>(() =>
typeof window === 'undefined' ? null : ownerDocument?.createElement('div') ?? null
)
let ready = useServerHandoffComplete()
let trulyUnmounted = useRef(false)
useIsoMorphicEffect(() => {
trulyUnmounted.current = false
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)
}
return () => {
trulyUnmounted.current = true
microTask(() => {
if (!trulyUnmounted.current) return
if (!target || !element) return
target.removeChild(element)
if (target.childNodes.length <= 0) {
target.parentElement?.removeChild(target)
}
})
}
}, [target, element])
if (!ready) return null
let ourProps = { ref: portalRef }
return !target || !element
? null
: createPortal(
render({
ourProps,
theirProps,
defaultTag: DEFAULT_PORTAL_TAG,
name: 'Portal',
}),
element
)
})
// ---
let DEFAULT_GROUP_TAG = Fragment
interface GroupRenderPropArg {}
let PortalGroupContext = createContext<MutableRefObject<HTMLElement | null> | null>(null)
let Group = forwardRefWithAs(function Group<TTag extends ElementType = typeof DEFAULT_GROUP_TAG>(
props: Props<TTag, GroupRenderPropArg> & {
target: MutableRefObject<HTMLElement | null>
},
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>
)
})
// ---
export let Portal = Object.assign(PortalRoot, { Group })