-
-
Notifications
You must be signed in to change notification settings - Fork 639
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Clauderic Demers
committed
Mar 23, 2021
1 parent
4022411
commit f4f42c4
Showing
8 changed files
with
198 additions
and
200 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,8 @@ | ||
| export { | ||
| ActiveDraggableContext, | ||
| DndContext, | ||
| LayoutMeasuringStrategy, | ||
| LayoutMeasuringFrequency, | ||
| } from './DndContext'; | ||
| export {ActiveDraggableContext, DndContext} from './DndContext'; | ||
| export type { | ||
| CancelDrop, | ||
| DragStartEvent, | ||
| DragMoveEvent, | ||
| DragOverEvent, | ||
| DragEndEvent, | ||
| LayoutMeasuring, | ||
| } from './DndContext'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
154 changes: 154 additions & 0 deletions
154
packages/core/src/hooks/utilities/useLayoutMeasuring.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| import {useCallback, useEffect, useRef, useState} from 'react'; | ||
| import {useLazyMemo, useIsomorphicLayoutEffect} from '@dnd-kit/utilities'; | ||
|
|
||
| import {getElementLayout} from '../../utilities'; | ||
| import type {DroppableContainers, LayoutRectMap} from '../../store/types'; | ||
|
|
||
| interface Arguments { | ||
| dragging: boolean; | ||
| dependencies: any[]; | ||
| config: Partial<LayoutMeasuring> | undefined; | ||
| } | ||
|
|
||
| export enum LayoutMeasuringStrategy { | ||
| Always = 'always', | ||
| WhileDragging = 'while-dragging', | ||
| } | ||
|
|
||
| export enum LayoutMeasuringFrequency { | ||
| Optimized = 'optimized', | ||
| } | ||
|
|
||
| export interface LayoutMeasuring { | ||
| strategy: LayoutMeasuringStrategy; | ||
| frequency: LayoutMeasuringFrequency | number; | ||
| } | ||
|
|
||
| const defaultValue: LayoutRectMap = new Map(); | ||
|
|
||
| export function useLayoutMeasuring( | ||
| containers: DroppableContainers, | ||
| {dragging, dependencies, config}: Arguments | ||
| ) { | ||
| const [willRecomputeLayouts, setWillRecomputeLayouts] = useState(false); | ||
| const {frequency, strategy} = getLayoutMeasuring(config); | ||
| const containersRef = useRef(containers); | ||
| const recomputeLayouts = useCallback(() => { | ||
| setWillRecomputeLayouts(true); | ||
| }, []); | ||
| const recomputeLayoutsTimeoutId = useRef<NodeJS.Timeout | null>(null); | ||
| const disabled = | ||
| strategy === LayoutMeasuringStrategy.Always ? false : dragging; | ||
| const layoutRectMap = useLazyMemo<LayoutRectMap>( | ||
| (previousValue) => { | ||
| if (disabled) { | ||
| return defaultValue; | ||
| } | ||
|
|
||
| if ( | ||
| !previousValue || | ||
| previousValue === defaultValue || | ||
| containersRef.current !== containers || | ||
| willRecomputeLayouts | ||
| ) { | ||
| for (let container of Object.values(containers)) { | ||
| if (!container) { | ||
| continue; | ||
| } | ||
|
|
||
| container.rect.current = container.node.current | ||
| ? getElementLayout(container.node.current) | ||
| : null; | ||
| } | ||
|
|
||
| return createLayoutRectMap(containers); | ||
| } | ||
|
|
||
| return previousValue; | ||
| }, | ||
| [containers, disabled, willRecomputeLayouts] | ||
| ); | ||
|
|
||
| useEffect(() => { | ||
| containersRef.current = containers; | ||
| }, [containers]); | ||
|
|
||
| useEffect(() => { | ||
| if (willRecomputeLayouts) { | ||
| setWillRecomputeLayouts(false); | ||
| } | ||
| }, [willRecomputeLayouts]); | ||
|
|
||
| useIsomorphicLayoutEffect( | ||
| function recompute() { | ||
| if (disabled) { | ||
| return; | ||
| } | ||
|
|
||
| requestAnimationFrame(() => recomputeLayouts()); | ||
| }, | ||
| // eslint-disable-next-line react-hooks/exhaustive-deps | ||
| [dragging, disabled] | ||
| ); | ||
|
|
||
| useEffect( | ||
| function forceRecomputeLayouts() { | ||
| if ( | ||
| disabled || | ||
| typeof frequency !== 'number' || | ||
| recomputeLayoutsTimeoutId.current !== null | ||
| ) { | ||
| return; | ||
| } | ||
|
|
||
| recomputeLayoutsTimeoutId.current = setTimeout(() => { | ||
| recomputeLayouts(); | ||
| recomputeLayoutsTimeoutId.current = null; | ||
| }, frequency); | ||
| }, | ||
| // eslint-disable-next-line react-hooks/exhaustive-deps | ||
| [frequency, disabled, recomputeLayouts, ...dependencies] | ||
| ); | ||
|
|
||
| return {layoutRectMap, recomputeLayouts, willRecomputeLayouts}; | ||
| } | ||
|
|
||
| function createLayoutRectMap( | ||
| containers: DroppableContainers | null | ||
| ): LayoutRectMap { | ||
| const layoutRectMap: LayoutRectMap = new Map(); | ||
|
|
||
| if (containers) { | ||
| for (const container of Object.values(containers)) { | ||
| if (!container) { | ||
| continue; | ||
| } | ||
|
|
||
| const {id, rect, disabled} = container; | ||
|
|
||
| if (disabled || rect.current == null) { | ||
| continue; | ||
| } | ||
|
|
||
| layoutRectMap.set(id, rect.current); | ||
| } | ||
| } | ||
|
|
||
| return layoutRectMap; | ||
| } | ||
|
|
||
| const defaultLayoutMeasuring: LayoutMeasuring = { | ||
| strategy: LayoutMeasuringStrategy.WhileDragging, | ||
| frequency: LayoutMeasuringFrequency.Optimized, | ||
| }; | ||
|
|
||
| function getLayoutMeasuring( | ||
| layoutMeasuring: Arguments['config'] | ||
| ): LayoutMeasuring { | ||
| return layoutMeasuring | ||
| ? { | ||
| ...defaultLayoutMeasuring, | ||
| ...layoutMeasuring, | ||
| } | ||
| : defaultLayoutMeasuring; | ||
| } |
Oops, something went wrong.