-
Notifications
You must be signed in to change notification settings - Fork 1k
/
transition.tsx
680 lines (587 loc) · 19.8 KB
/
transition.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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
'use client'
import React, {
Fragment,
createContext,
useContext,
useMemo,
useRef,
useState,
type ElementType,
type MutableRefObject,
type Ref,
} from 'react'
import { useDisposables } from '../../hooks/use-disposables'
import { useEvent } from '../../hooks/use-event'
import { useFlags } from '../../hooks/use-flags'
import { useIsMounted } from '../../hooks/use-is-mounted'
import { useIsoMorphicEffect } from '../../hooks/use-iso-morphic-effect'
import { useLatestValue } from '../../hooks/use-latest-value'
import { useOnDisappear } from '../../hooks/use-on-disappear'
import { useServerHandoffComplete } from '../../hooks/use-server-handoff-complete'
import { useSyncRefs } from '../../hooks/use-sync-refs'
import { useTransition } from '../../hooks/use-transition'
import { OpenClosedProvider, State, useOpenClosed } from '../../internal/open-closed'
import type { Props, ReactTag } from '../../types'
import { classNames } from '../../utils/class-names'
import { match } from '../../utils/match'
import {
RenderFeatures,
RenderStrategy,
forwardRefWithAs,
render,
type HasDisplayName,
type PropsForFeatures,
type RefProp,
} from '../../utils/render'
type ContainerElement = MutableRefObject<HTMLElement | null>
type TransitionDirection = 'enter' | 'leave' | 'idle'
/**
* Split class lists by whitespace
*
* We can't check for just spaces as all whitespace characters are
* invalid in a class name, so we have to split on ANY whitespace.
*/
function splitClasses(classes: string = '') {
return classes.split(/\s+/).filter((className) => className.length > 1)
}
/**
* Check if we should forward the ref to the child element or not. This is to
* prevent crashes when the `as` prop is a Fragment _and_ the component just acts
* as a state container (aka, there is no actual transition happening).
*
* E.g.:
*
* ```tsx
* <Transition show={true}>
* <Transition.Child enter="duration-100"><div>Child 1</div></Transition.Child>
* <Transition.Child enter="duration-200"><div>Child 2</div></Transition.Child>
* </Transition>
* ```
*
* In this scenario, the child components are transitioning, but the
* `Transition` parent, which is a `Fragment`, is not. So we should not forward
* the ref to the `Fragment`.
*/
function shouldForwardRef<TTag extends ElementType = typeof DEFAULT_TRANSITION_CHILD_TAG>(
props: TransitionRootProps<TTag>
) {
return (
// If we have any of the enter/leave classes
Boolean(
props.enter ||
props.enterFrom ||
props.enterTo ||
props.leave ||
props.leaveFrom ||
props.leaveTo
) ||
// If the `as` prop is not a Fragment
(props.as ?? DEFAULT_TRANSITION_CHILD_TAG) !== Fragment ||
// If we have a single child, then we can forward the ref directly
React.Children.count(props.children) === 1
)
}
interface TransitionContextValues {
show: boolean
appear: boolean
initial: boolean
}
let TransitionContext = createContext<TransitionContextValues | null>(null)
TransitionContext.displayName = 'TransitionContext'
enum TreeStates {
Visible = 'visible',
Hidden = 'hidden',
}
export interface TransitionClasses {
enter?: string
enterFrom?: string
enterTo?: string
/**
* @deprecated The `enterTo` and `leaveTo` classes stay applied after the transition has finished.
*/
entered?: string
leave?: string
leaveFrom?: string
leaveTo?: string
}
export interface TransitionEvents {
beforeEnter?: () => void
afterEnter?: () => void
beforeLeave?: () => void
afterLeave?: () => void
}
type TransitionChildPropsWeControl = never
export type TransitionChildProps<TTag extends ReactTag> = Props<
TTag,
TransitionChildRenderPropArg,
TransitionChildPropsWeControl,
PropsForFeatures<typeof TransitionChildRenderFeatures> &
TransitionClasses &
TransitionEvents & { appear?: boolean }
>
function useTransitionContext() {
let context = useContext(TransitionContext)
if (context === null) {
throw new Error(
'A <Transition.Child /> is used but it is missing a parent <Transition /> or <Transition.Root />.'
)
}
return context
}
function useParentNesting() {
let context = useContext(NestingContext)
if (context === null) {
throw new Error(
'A <Transition.Child /> is used but it is missing a parent <Transition /> or <Transition.Root />.'
)
}
return context
}
interface NestingContextValues {
children: MutableRefObject<{ el: ContainerElement; state: TreeStates }[]>
register: (el: ContainerElement) => () => void
unregister: (el: ContainerElement, strategy?: RenderStrategy) => void
onStart: (el: ContainerElement, direction: TransitionDirection, cb: () => void) => void
onStop: (el: ContainerElement, direction: TransitionDirection, cb: () => void) => void
chains: MutableRefObject<
Record<TransitionDirection, [container: ContainerElement, promise: Promise<void>][]>
>
wait: MutableRefObject<Promise<void>>
}
let NestingContext = createContext<NestingContextValues | null>(null)
NestingContext.displayName = 'NestingContext'
function hasChildren(
bag: NestingContextValues['children'] | { children: NestingContextValues['children'] }
): boolean {
if ('children' in bag) return hasChildren(bag.children)
return (
bag.current
.filter(({ el }) => el.current !== null)
.filter(({ state }) => state === TreeStates.Visible).length > 0
)
}
function useNesting(done?: () => void, parent?: NestingContextValues) {
let doneRef = useLatestValue(done)
let transitionableChildren = useRef<NestingContextValues['children']['current']>([])
let mounted = useIsMounted()
let d = useDisposables()
let unregister = useEvent((container: ContainerElement, strategy = RenderStrategy.Hidden) => {
let idx = transitionableChildren.current.findIndex(({ el }) => el === container)
if (idx === -1) return
match(strategy, {
[RenderStrategy.Unmount]() {
transitionableChildren.current.splice(idx, 1)
},
[RenderStrategy.Hidden]() {
transitionableChildren.current[idx].state = TreeStates.Hidden
},
})
d.microTask(() => {
if (!hasChildren(transitionableChildren) && mounted.current) {
doneRef.current?.()
}
})
})
let register = useEvent((container: ContainerElement) => {
let child = transitionableChildren.current.find(({ el }) => el === container)
if (!child) {
transitionableChildren.current.push({ el: container, state: TreeStates.Visible })
} else if (child.state !== TreeStates.Visible) {
child.state = TreeStates.Visible
}
return () => unregister(container, RenderStrategy.Unmount)
})
let todos = useRef<(() => void)[]>([])
let wait = useRef<Promise<void>>(Promise.resolve())
let chains = useRef<
Record<TransitionDirection, [identifier: ContainerElement, promise: Promise<void>][]>
>({
enter: [],
leave: [],
idle: [],
})
let onStart = useEvent(
(
container: ContainerElement,
direction: TransitionDirection,
cb: (direction: TransitionDirection) => void
) => {
// Clear out all existing todos
todos.current.splice(0)
// Remove all existing promises for the current container from the parent because we can
// ignore those and use only the new one.
if (parent) {
parent.chains.current[direction] = parent.chains.current[direction].filter(
([containerInParent]) => containerInParent !== container
)
}
// Wait until our own transition is done
parent?.chains.current[direction].push([
container,
new Promise<void>((resolve) => {
todos.current.push(resolve)
}),
])
// Wait until our children are done
parent?.chains.current[direction].push([
container,
new Promise<void>((resolve) => {
Promise.all(chains.current[direction].map(([_container, promise]) => promise)).then(() =>
resolve()
)
}),
])
if (direction === 'enter') {
wait.current = wait.current.then(() => parent?.wait.current).then(() => cb(direction))
} else {
cb(direction)
}
}
)
let onStop = useEvent(
(
_container: ContainerElement,
direction: TransitionDirection,
cb: (direction: TransitionDirection) => void
) => {
Promise.all(chains.current[direction].splice(0).map(([_container, promise]) => promise)) // Wait for my children
.then(() => {
todos.current.shift()?.() // I'm ready
})
.then(() => cb(direction))
}
)
return useMemo(
() => ({
children: transitionableChildren,
register,
unregister,
onStart,
onStop,
wait,
chains,
}),
[register, unregister, transitionableChildren, onStart, onStop, chains, wait]
)
}
// ---
let DEFAULT_TRANSITION_CHILD_TAG = Fragment
type TransitionChildRenderPropArg = MutableRefObject<HTMLDivElement>
let TransitionChildRenderFeatures = RenderFeatures.RenderStrategy
function TransitionChildFn<TTag extends ElementType = typeof DEFAULT_TRANSITION_CHILD_TAG>(
props: TransitionChildProps<TTag>,
ref: Ref<HTMLElement>
) {
let {
// Event "handlers"
beforeEnter,
afterEnter,
beforeLeave,
afterLeave,
// Class names
enter,
enterFrom,
enterTo,
entered,
leave,
leaveFrom,
leaveTo,
// @ts-expect-error
...rest
} = props as typeof props
let container = useRef<HTMLElement | null>(null)
let requiresRef = shouldForwardRef(props)
let transitionRef = useSyncRefs(...(requiresRef ? [container, ref] : ref === null ? [] : [ref]))
let strategy = rest.unmount ?? true ? RenderStrategy.Unmount : RenderStrategy.Hidden
let { show, appear, initial } = useTransitionContext()
let [state, setState] = useState(show ? TreeStates.Visible : TreeStates.Hidden)
let parentNesting = useParentNesting()
let { register, unregister } = parentNesting
useIsoMorphicEffect(() => register(container), [register, container])
useIsoMorphicEffect(() => {
// If we are in another mode than the Hidden mode then ignore
if (strategy !== RenderStrategy.Hidden) return
if (!container.current) return
// Make sure that we are visible
if (show && state !== TreeStates.Visible) {
setState(TreeStates.Visible)
return
}
return match(state, {
[TreeStates.Hidden]: () => unregister(container),
[TreeStates.Visible]: () => register(container),
})
}, [state, container, register, unregister, show, strategy])
let classes = useLatestValue({
base: splitClasses(rest.className),
enter: splitClasses(enter),
enterFrom: splitClasses(enterFrom),
enterTo: splitClasses(enterTo),
entered: splitClasses(entered),
leave: splitClasses(leave),
leaveFrom: splitClasses(leaveFrom),
leaveTo: splitClasses(leaveTo),
})
let events = useLatestValue({
beforeEnter,
afterEnter,
beforeLeave,
afterLeave,
})
let ready = useServerHandoffComplete()
useIsoMorphicEffect(() => {
if (!requiresRef) return
if (ready && state === TreeStates.Visible && container.current === null) {
throw new Error('Did you forget to passthrough the `ref` to the actual DOM node?')
}
}, [container, state, ready, requiresRef])
// Skipping initial transition
let skip = initial && !appear
let immediate = appear && show && initial
let transitionDirection = (() => {
if (immediate) return 'enter'
if (!ready) return 'idle'
if (skip) return 'idle'
return show ? 'enter' : 'leave'
})() as TransitionDirection
let transitionStateFlags = useFlags(0)
let beforeEvent = useEvent((direction: TransitionDirection) => {
return match(direction, {
enter: () => {
transitionStateFlags.addFlag(State.Opening)
events.current.beforeEnter?.()
},
leave: () => {
transitionStateFlags.addFlag(State.Closing)
events.current.beforeLeave?.()
},
idle: () => {},
})
})
let afterEvent = useEvent((direction: TransitionDirection) => {
return match(direction, {
enter: () => {
transitionStateFlags.removeFlag(State.Opening)
events.current.afterEnter?.()
},
leave: () => {
transitionStateFlags.removeFlag(State.Closing)
events.current.afterLeave?.()
},
idle: () => {},
})
})
let isTransitioning = useRef(false)
let nesting = useNesting(() => {
// When all children have been unmounted we can only hide ourselves if and
// only if we are not transitioning ourselves. Otherwise we would unmount
// before the transitions are finished.
if (isTransitioning.current) return
setState(TreeStates.Hidden)
unregister(container)
}, parentNesting)
useTransition({
container,
classes,
direction: transitionDirection,
onStart: useLatestValue((direction) => {
isTransitioning.current = true
nesting.onStart(container, direction, beforeEvent)
}),
onStop: useLatestValue((direction) => {
isTransitioning.current = false
nesting.onStop(container, direction, afterEvent)
if (direction === 'leave' && !hasChildren(nesting)) {
// When we don't have children anymore we can safely unregister from the
// parent and hide ourselves.
setState(TreeStates.Hidden)
unregister(container)
}
}),
})
let theirProps = rest
let ourProps = { ref: transitionRef }
// Already apply the `enter` and `enterFrom` on the server if required
if (immediate) {
theirProps = {
...theirProps,
className: classNames(rest.className, ...classes.current.enter, ...classes.current.enterFrom),
}
}
// If we are re-rendering while we are transitioning, then we should ensure that the classes are
// not mutated by React itself because we are handling the transition ourself.
else if (isTransitioning.current) {
// When we re-render while we are in the middle of the transition, then we should take the
// incoming className and the current classes that are applied.
//
// This is a bit dirty, but we need to make sure React is not applying changes to the class
// attribute while we are transitioning.
theirProps.className = classNames(rest.className, container.current?.className)
if (theirProps.className === '') delete theirProps.className
}
// If we were never transitioning, or we're not transitioning anymore, then
// apply the `enterTo` and `leaveTo` classes as the final state.
else {
theirProps.className = classNames(
rest.className,
container.current?.className,
...match(transitionDirection, {
enter: [...classes.current.enterTo, ...classes.current.entered],
leave: classes.current.leaveTo,
idle: [],
})
)
if (theirProps.className === '') delete theirProps.className
}
return (
<NestingContext.Provider value={nesting}>
<OpenClosedProvider
value={
match(state, {
[TreeStates.Visible]: State.Open,
[TreeStates.Hidden]: State.Closed,
}) | transitionStateFlags.flags
}
>
{render({
ourProps,
theirProps,
defaultTag: DEFAULT_TRANSITION_CHILD_TAG,
features: TransitionChildRenderFeatures,
visible: state === TreeStates.Visible,
name: 'Transition.Child',
})}
</OpenClosedProvider>
</NestingContext.Provider>
)
}
export type TransitionRootProps<TTag extends ElementType = typeof DEFAULT_TRANSITION_CHILD_TAG> =
TransitionChildProps<TTag> & {
show?: boolean
appear?: boolean
}
function TransitionRootFn<TTag extends ElementType = typeof DEFAULT_TRANSITION_CHILD_TAG>(
props: TransitionRootProps<TTag>,
ref: Ref<HTMLElement>
) {
// @ts-expect-error
let { show, appear = false, unmount = true, ...theirProps } = props as typeof props
let internalTransitionRef = useRef<HTMLElement | null>(null)
let requiresRef = shouldForwardRef(props)
let transitionRef = useSyncRefs(
...(requiresRef ? [internalTransitionRef, ref] : ref === null ? [] : [ref])
)
// The TransitionChild will also call this hook, and we have to make sure that we are ready.
useServerHandoffComplete()
let usesOpenClosedState = useOpenClosed()
if (show === undefined && usesOpenClosedState !== null) {
show = (usesOpenClosedState & State.Open) === State.Open
}
if (show === undefined) {
throw new Error('A <Transition /> is used but it is missing a `show={true | false}` prop.')
}
let [state, setState] = useState(show ? TreeStates.Visible : TreeStates.Hidden)
let nestingBag = useNesting(() => {
if (show) return
setState(TreeStates.Hidden)
})
let [initial, setInitial] = useState(true)
// Change the `initial` value
let changes = useRef([show])
useIsoMorphicEffect(() => {
// We can skip this effect
if (initial === false) {
return
}
// Track the changes
if (changes.current[changes.current.length - 1] !== show) {
changes.current.push(show)
setInitial(false)
}
}, [changes, show])
let transitionBag = useMemo<TransitionContextValues>(
() => ({ show, appear, initial }),
[show, appear, initial]
)
// Ensure we change the tree state to hidden once the transition becomes hidden
useOnDisappear(internalTransitionRef, () => setState(TreeStates.Hidden))
useIsoMorphicEffect(() => {
if (show) {
setState(TreeStates.Visible)
} else if (!hasChildren(nestingBag) && internalTransitionRef.current !== null) {
setState(TreeStates.Hidden)
}
}, [show, nestingBag])
let sharedProps = { unmount }
let beforeEnter = useEvent(() => {
if (initial) setInitial(false)
props.beforeEnter?.()
})
let beforeLeave = useEvent(() => {
if (initial) setInitial(false)
props.beforeLeave?.()
})
return (
<NestingContext.Provider value={nestingBag}>
<TransitionContext.Provider value={transitionBag}>
{render({
ourProps: {
...sharedProps,
as: Fragment,
children: (
<InternalTransitionChild
ref={transitionRef}
{...sharedProps}
{...theirProps}
beforeEnter={beforeEnter}
beforeLeave={beforeLeave}
/>
),
},
theirProps: {},
defaultTag: Fragment,
features: TransitionChildRenderFeatures,
visible: state === TreeStates.Visible,
name: 'Transition',
})}
</TransitionContext.Provider>
</NestingContext.Provider>
)
}
function ChildFn<TTag extends ElementType = typeof DEFAULT_TRANSITION_CHILD_TAG>(
props: TransitionChildProps<TTag>,
ref: MutableRefObject<HTMLElement>
) {
let hasTransitionContext = useContext(TransitionContext) !== null
let hasOpenClosedContext = useOpenClosed() !== null
return (
<>
{!hasTransitionContext && hasOpenClosedContext ? (
// @ts-expect-error This is an object
<TransitionRoot ref={ref} {...props} />
) : (
// @ts-expect-error This is an object
<InternalTransitionChild ref={ref} {...props} />
)}
</>
)
}
export interface _internal_ComponentTransitionRoot extends HasDisplayName {
<TTag extends ElementType = typeof DEFAULT_TRANSITION_CHILD_TAG>(
props: TransitionRootProps<TTag> & RefProp<typeof TransitionRootFn>
): JSX.Element
}
export interface _internal_ComponentTransitionChild extends HasDisplayName {
<TTag extends ElementType = typeof DEFAULT_TRANSITION_CHILD_TAG>(
props: TransitionChildProps<TTag> & RefProp<typeof TransitionChildFn>
): JSX.Element
}
let TransitionRoot = forwardRefWithAs(TransitionRootFn) as _internal_ComponentTransitionRoot
let InternalTransitionChild = forwardRefWithAs(
TransitionChildFn
) as _internal_ComponentTransitionChild
export let TransitionChild = forwardRefWithAs(ChildFn) as _internal_ComponentTransitionChild
export let Transition = Object.assign(TransitionRoot, {
Child: TransitionChild,
Root: TransitionRoot,
})