refactor(selection): improve performance

This commit is contained in:
moklick
2022-12-08 21:58:24 +01:00
parent 36e4e773ce
commit 08faffacee
4 changed files with 78 additions and 66 deletions
@@ -0,0 +1,30 @@
import shallow from 'zustand/shallow';
import { useStore } from '../../hooks/useStore';
import { ReactFlowState } from '../../types';
const selector = (s: ReactFlowState) => ({
userSelectionActive: s.userSelectionActive,
userSelectionRect: s.userSelectionRect,
});
function SelectionBox() {
const { userSelectionActive, userSelectionRect } = useStore(selector, shallow);
const showSelectionBox = userSelectionActive && userSelectionRect;
if (!showSelectionBox) {
return null;
}
return (
<div
className="react-flow__selection react-flow__container"
style={{
width: userSelectionRect.width,
height: userSelectionRect.height,
transform: `translate(${userSelectionRect.x}px, ${userSelectionRect.y}px)`,
}}
/>
);
}
export default SelectionBox;
@@ -2,23 +2,17 @@
* The user selection rectangle gets displayed when a user drags the mouse while pressing shift * The user selection rectangle gets displayed when a user drags the mouse while pressing shift
*/ */
import { memo, useState, useRef, MouseEvent as ReactMouseEvent } from 'react'; import { memo, useRef, MouseEvent as ReactMouseEvent } from 'react';
import shallow from 'zustand/shallow'; import shallow from 'zustand/shallow';
import cc from 'classcat'; import cc from 'classcat';
import SelectionBox from './SelectionBox';
import { containerStyle } from '../../styles'; import { containerStyle } from '../../styles';
import { useStore, useStoreApi } from '../../hooks/useStore'; import { useStore, useStoreApi } from '../../hooks/useStore';
import { getSelectionChanges } from '../../utils/changes'; import { getSelectionChanges } from '../../utils/changes';
import { getConnectedEdges, getNodesInside } from '../../utils/graph'; import { getConnectedEdges, getNodesInside } from '../../utils/graph';
import { SelectionMode } from '../../types'; import { SelectionMode } from '../../types';
import type { XYPosition, ReactFlowState, NodeChange, EdgeChange, Rect } from '../../types'; import type { XYPosition, ReactFlowState, NodeChange, EdgeChange } from '../../types';
type SelectionRect = Rect & {
startX: number;
startY: number;
};
type EventHandlers = { [key: string]: React.MouseEventHandler | React.WheelEventHandler | undefined };
type UserSelectionProps = { type UserSelectionProps = {
isSelectionMode: boolean; isSelectionMode: boolean;
@@ -54,12 +48,6 @@ const wrapHandler = (
}; };
}; };
const wrapHandlers = (
handlers: EventHandlers,
containerRef: React.MutableRefObject<HTMLDivElement | null>
): EventHandlers =>
Object.keys(handlers).reduce((hls, key) => ({ ...hls, [key]: wrapHandler(handlers[key], containerRef) }), {});
const selector = (s: ReactFlowState) => ({ const selector = (s: ReactFlowState) => ({
userSelectionActive: s.userSelectionActive, userSelectionActive: s.userSelectionActive,
elementsSelectable: s.elementsSelectable, elementsSelectable: s.elementsSelectable,
@@ -86,13 +74,10 @@ const UserSelection = memo(
const prevSelectedNodesCount = useRef<number>(0); const prevSelectedNodesCount = useRef<number>(0);
const prevSelectedEdgesCount = useRef<number>(0); const prevSelectedEdgesCount = useRef<number>(0);
const containerBounds = useRef<DOMRect>(); const containerBounds = useRef<DOMRect>();
const [userSelectionRect, setUserSelectionRect] = useState<SelectionRect | null>(null);
const { userSelectionActive, elementsSelectable, paneDragging } = useStore(selector, shallow); const { userSelectionActive, elementsSelectable, paneDragging } = useStore(selector, shallow);
const resetUserSelection = () => { const resetUserSelection = () => {
setUserSelectionRect(null); store.setState({ userSelectionActive: false, userSelectionRect: null });
store.setState({ userSelectionActive: false });
prevSelectedNodesCount.current = 0; prevSelectedNodesCount.current = 0;
prevSelectedEdgesCount.current = 0; prevSelectedEdgesCount.current = 0;
@@ -116,30 +101,39 @@ const UserSelection = memo(
const onWheel = onPaneScroll ? (event: React.WheelEvent) => onPaneScroll(event) : undefined; const onWheel = onPaneScroll ? (event: React.WheelEvent) => onPaneScroll(event) : undefined;
const onMouseDown = (event: ReactMouseEvent): void => { const onMouseDown = (event: ReactMouseEvent): void => {
if (!elementsSelectable || !isSelectionMode || event.button !== 0 || event.target !== container.current) { const { resetSelectedElements, domNode } = store.getState();
if (
!elementsSelectable ||
!isSelectionMode ||
event.button !== 0 ||
event.target !== container.current ||
!domNode
) {
return; return;
} }
store.getState().resetSelectedElements(); containerBounds.current = domNode.getBoundingClientRect();
const { x, y } = getMousePosition(event, containerBounds.current!);
const reactFlowNode = (event.target as Element).closest('.react-flow')!; resetSelectedElements();
containerBounds.current = reactFlowNode.getBoundingClientRect();
const mousePos = getMousePosition(event, containerBounds.current!); store.setState({
userSelectionRect: {
setUserSelectionRect({ width: 0,
width: 0, height: 0,
height: 0, startX: x,
startX: mousePos.x, startY: y,
startY: mousePos.y, x,
x: mousePos.x, y,
y: mousePos.y, },
}); });
onSelectionStart?.(event); onSelectionStart?.(event);
}; };
const onMouseMove = (event: ReactMouseEvent): void => { const onMouseMove = (event: ReactMouseEvent): void => {
const { userSelectionRect, nodeInternals, edges, transform, onNodesChange, onEdgesChange, nodeOrigin, getNodes } =
store.getState();
if (!isSelectionMode || !containerBounds.current || !userSelectionRect) { if (!isSelectionMode || !containerBounds.current || !userSelectionRect) {
return; return;
} }
@@ -158,7 +152,6 @@ const UserSelection = memo(
height: Math.abs(mousePos.y - startY), height: Math.abs(mousePos.y - startY),
}; };
const { nodeInternals, edges, transform, onNodesChange, onEdgesChange, nodeOrigin, getNodes } = store.getState();
const nodes = getNodes(); const nodes = getNodes();
const selectedNodes = getNodesInside( const selectedNodes = getNodesInside(
nodeInternals, nodeInternals,
@@ -187,10 +180,13 @@ const UserSelection = memo(
} }
} }
setUserSelectionRect(nextUserSelectRect); store.setState({
userSelectionRect: nextUserSelectRect,
});
}; };
const onMouseUp = (event: ReactMouseEvent) => { const onMouseUp = (event: ReactMouseEvent) => {
const { userSelectionRect } = store.getState();
// We only want to trigger click functions when in selection mode if // We only want to trigger click functions when in selection mode if
// the user did not move the mouse. // the user did not move the mouse.
if (!userSelectionActive && userSelectionRect && event.target === container.current) { if (!userSelectionActive && userSelectionRect && event.target === container.current) {
@@ -200,7 +196,6 @@ const UserSelection = memo(
store.setState({ nodesSelectionActive: prevSelectedNodesCount.current > 0 }); store.setState({ nodesSelectionActive: prevSelectedNodesCount.current > 0 });
resetUserSelection(); resetUserSelection();
onSelectionEnd?.(event); onSelectionEnd?.(event);
}; };
@@ -209,29 +204,11 @@ const UserSelection = memo(
store.setState({ nodesSelectionActive: prevSelectedNodesCount.current > 0 }); store.setState({ nodesSelectionActive: prevSelectedNodesCount.current > 0 });
onSelectionEnd?.(event); onSelectionEnd?.(event);
} }
resetUserSelection(); resetUserSelection();
}; };
const eventHandlers = const hasActiveSelection = elementsSelectable && (isSelectionMode || userSelectionActive);
elementsSelectable && (isSelectionMode || userSelectionActive)
? {
...wrapHandlers({ onContextMenu, onWheel }, container),
onMouseDown,
onMouseMove,
onMouseUp,
onMouseLeave,
}
: wrapHandlers(
{
onClick,
onContextMenu,
onWheel,
onMouseEnter: onPaneMouseEnter,
onMouseMove: onPaneMouseMove,
onMouseLeave: onPaneMouseLeave,
},
container
);
return ( return (
<div <div
@@ -240,21 +217,19 @@ const UserSelection = memo(
'react-flow__container', 'react-flow__container',
{ dragging: paneDragging, selection: isSelectionMode }, { dragging: paneDragging, selection: isSelectionMode },
])} ])}
{...eventHandlers} onClick={hasActiveSelection ? undefined : wrapHandler(onClick, container)}
onContextMenu={wrapHandler(onContextMenu, container)}
onWheel={wrapHandler(onWheel, container)}
onMouseEnter={hasActiveSelection ? undefined : onPaneMouseEnter}
onMouseDown={hasActiveSelection ? onMouseDown : undefined}
onMouseMove={hasActiveSelection ? onMouseMove : onPaneMouseMove}
onMouseUp={hasActiveSelection ? onMouseUp : undefined}
onMouseLeave={hasActiveSelection ? onMouseLeave : onPaneMouseLeave}
ref={container} ref={container}
style={containerStyle} style={containerStyle}
> >
{children} {children}
{userSelectionActive && userSelectionRect && ( <SelectionBox />
<div
className="react-flow__selection react-flow__container"
style={{
width: userSelectionRect.width,
height: userSelectionRect.height,
transform: `translate(${userSelectionRect.x}px, ${userSelectionRect.y}px)`,
}}
/>
)}
</div> </div>
); );
} }
+1
View File
@@ -26,6 +26,7 @@ const initialState: ReactFlowStore = {
nodeExtent: infiniteExtent, nodeExtent: infiniteExtent,
nodesSelectionActive: false, nodesSelectionActive: false,
userSelectionActive: false, userSelectionActive: false,
userSelectionRect: null,
connectionNodeId: null, connectionNodeId: null,
connectionHandleId: null, connectionHandleId: null,
connectionHandleType: 'source', connectionHandleType: 'source',
+6
View File
@@ -155,6 +155,7 @@ export type ReactFlowStore = {
nodesSelectionActive: boolean; nodesSelectionActive: boolean;
userSelectionActive: boolean; userSelectionActive: boolean;
userSelectionRect: SelectionRect | null;
connectionNodeId: string | null; connectionNodeId: string | null;
connectionHandleId: string | null; connectionHandleId: string | null;
@@ -254,3 +255,8 @@ export enum SelectionMode {
Overlap = 'overlap', Overlap = 'overlap',
Contained = 'contained', Contained = 'contained',
} }
export type SelectionRect = Rect & {
startX: number;
startY: number;
};