From 685ff76ee8033a70400b1116a44db225a5c94a57 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Fri, 23 Sep 2022 14:25:04 +0100 Subject: [PATCH 01/35] feat: add a selectBoxOnDrag prop which allows select box to be triggered without an additional key press. --- .../core/src/container/FlowRenderer/index.tsx | 4 ++-- .../core/src/container/GraphView/index.tsx | 2 ++ .../core/src/container/ReactFlow/index.tsx | 2 ++ .../core/src/container/ZoomPane/index.tsx | 20 +++++++++++-------- packages/core/src/types/component-props.ts | 1 + 5 files changed, 19 insertions(+), 10 deletions(-) diff --git a/packages/core/src/container/FlowRenderer/index.tsx b/packages/core/src/container/FlowRenderer/index.tsx index e3faed9c..fda81982 100644 --- a/packages/core/src/container/FlowRenderer/index.tsx +++ b/packages/core/src/container/FlowRenderer/index.tsx @@ -44,6 +44,7 @@ const FlowRenderer = ({ onMoveStart, onMoveEnd, selectionKeyCode, + selectBoxOnDrag, multiSelectionKeyCode, zoomActivationKeyCode, elementsSelectable, @@ -84,7 +85,6 @@ const FlowRenderer = ({ onMove={onMove} onMoveStart={onMoveStart} onMoveEnd={onMoveEnd} - selectionKeyPressed={selectionKeyPressed} elementsSelectable={elementsSelectable} zoomOnScroll={zoomOnScroll} zoomOnPinch={zoomOnPinch} @@ -103,7 +103,7 @@ const FlowRenderer = ({ noPanClassName={noPanClassName} > {children} - + {nodesSelectionActive && ( ( connectionLineContainerStyle, deleteKeyCode = 'Backspace', selectionKeyCode = 'Shift', + selectBoxOnDrag = false, multiSelectionKeyCode = 'Meta', zoomActivationKeyCode = 'Meta', snapToGrid = false, @@ -193,6 +194,7 @@ const ReactFlow = forwardRef( connectionLineComponent={connectionLineComponent} connectionLineContainerStyle={connectionLineContainerStyle} selectionKeyCode={selectionKeyCode} + selectBoxOnDrag={selectBoxOnDrag} deleteKeyCode={deleteKeyCode} multiSelectionKeyCode={multiSelectionKeyCode} zoomActivationKeyCode={zoomActivationKeyCode} diff --git a/packages/core/src/container/ZoomPane/index.tsx b/packages/core/src/container/ZoomPane/index.tsx index a5783a7a..fce3a35f 100644 --- a/packages/core/src/container/ZoomPane/index.tsx +++ b/packages/core/src/container/ZoomPane/index.tsx @@ -16,8 +16,13 @@ import type { Viewport, ReactFlowState } from '../../types'; type ZoomPaneProps = Omit< FlowRendererProps, - 'deleteKeyCode' | 'selectionKeyCode' | 'multiSelectionKeyCode' | 'noDragClassName' | 'disableKeyboardA11y' -> & { selectionKeyPressed: boolean }; + | 'deleteKeyCode' + | 'selectionKeyCode' + | 'multiSelectionKeyCode' + | 'noDragClassName' + | 'disableKeyboardA11y' + | 'selectBoxOnDrag' +>; const viewChanged = (prevViewport: Viewport, eventViewport: any): boolean => prevViewport.x !== eventViewport.x || prevViewport.y !== eventViewport.y || prevViewport.zoom !== eventViewport.k; @@ -46,7 +51,6 @@ const ZoomPane = ({ panOnScrollSpeed = 0.5, panOnScrollMode = PanOnScrollMode.Free, zoomOnDoubleClick = true, - selectionKeyPressed, elementsSelectable, panOnDrag = true, defaultViewport, @@ -151,9 +155,9 @@ const ZoomPane = ({ useEffect(() => { if (d3Zoom) { - if (selectionKeyPressed && !isZoomingOrPanning.current) { + if (store.getState().userSelectionActive && !isZoomingOrPanning.current) { d3Zoom.on('zoom', null); - } else if (!selectionKeyPressed) { + } else if (!store.getState().userSelectionActive) { d3Zoom.on('zoom', (event: D3ZoomEvent) => { const { onViewportChange } = store.getState(); @@ -168,7 +172,7 @@ const ZoomPane = ({ }); } } - }, [selectionKeyPressed, d3Zoom, onMove]); + }, [store, d3Zoom, onMove]); useEffect(() => { if (d3Zoom) { @@ -238,7 +242,7 @@ const ZoomPane = ({ } // during a selection we prevent all other interactions - if (selectionKeyPressed) { + if (store.getState().userSelectionActive) { return false; } @@ -276,13 +280,13 @@ const ZoomPane = ({ }); } }, [ + store, d3Zoom, zoomOnScroll, zoomOnPinch, panOnScroll, zoomOnDoubleClick, panOnDrag, - selectionKeyPressed, elementsSelectable, zoomActivationKeyPressed, ]); diff --git a/packages/core/src/types/component-props.ts b/packages/core/src/types/component-props.ts index 9b273641..456122ce 100644 --- a/packages/core/src/types/component-props.ts +++ b/packages/core/src/types/component-props.ts @@ -94,6 +94,7 @@ export type ReactFlowProps = HTMLAttributes & { connectionMode?: ConnectionMode; deleteKeyCode?: KeyCode | null; selectionKeyCode?: KeyCode | null; + selectBoxOnDrag?: boolean; multiSelectionKeyCode?: KeyCode | null; zoomActivationKeyCode?: KeyCode | null; snapToGrid?: boolean; From 33e730d7b4a6030bbdd8bb6a72054e017f77714b Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Fri, 23 Sep 2022 14:55:49 +0100 Subject: [PATCH 02/35] bug fix: make sure we actually update event handlers when selection begins. --- packages/core/src/container/ZoomPane/index.tsx | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/packages/core/src/container/ZoomPane/index.tsx b/packages/core/src/container/ZoomPane/index.tsx index fce3a35f..c3ec9198 100644 --- a/packages/core/src/container/ZoomPane/index.tsx +++ b/packages/core/src/container/ZoomPane/index.tsx @@ -39,6 +39,7 @@ const selector = (s: ReactFlowState) => ({ d3Zoom: s.d3Zoom, d3Selection: s.d3Selection, d3ZoomHandler: s.d3ZoomHandler, + userSelectionActive: s.userSelectionActive, }); const ZoomPane = ({ @@ -68,7 +69,7 @@ const ZoomPane = ({ const isZoomingOrPanning = useRef(false); const zoomPane = useRef(null); const prevTransform = useRef({ x: 0, y: 0, zoom: 0 }); - const { d3Zoom, d3Selection, d3ZoomHandler } = useStore(selector, shallow); + const { d3Zoom, d3Selection, d3ZoomHandler, userSelectionActive } = useStore(selector, shallow); const zoomActivationKeyPressed = useKeyPress(zoomActivationKeyCode); useResizeHandler(zoomPane); @@ -155,9 +156,9 @@ const ZoomPane = ({ useEffect(() => { if (d3Zoom) { - if (store.getState().userSelectionActive && !isZoomingOrPanning.current) { + if (userSelectionActive && !isZoomingOrPanning.current) { d3Zoom.on('zoom', null); - } else if (!store.getState().userSelectionActive) { + } else if (!userSelectionActive) { d3Zoom.on('zoom', (event: D3ZoomEvent) => { const { onViewportChange } = store.getState(); @@ -172,7 +173,7 @@ const ZoomPane = ({ }); } } - }, [store, d3Zoom, onMove]); + }, [userSelectionActive, d3Zoom, onMove]); useEffect(() => { if (d3Zoom) { @@ -242,7 +243,7 @@ const ZoomPane = ({ } // during a selection we prevent all other interactions - if (store.getState().userSelectionActive) { + if (userSelectionActive) { return false; } @@ -280,7 +281,7 @@ const ZoomPane = ({ }); } }, [ - store, + userSelectionActive, d3Zoom, zoomOnScroll, zoomOnPinch, From 707ee19875b35bec410ed93b3863a64396aa4459 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Fri, 23 Sep 2022 15:02:40 +0100 Subject: [PATCH 03/35] feat: block pan on scroll if we are making a selection. --- packages/core/src/container/ZoomPane/index.tsx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/core/src/container/ZoomPane/index.tsx b/packages/core/src/container/ZoomPane/index.tsx index c3ec9198..c8050821 100644 --- a/packages/core/src/container/ZoomPane/index.tsx +++ b/packages/core/src/container/ZoomPane/index.tsx @@ -99,7 +99,7 @@ const ZoomPane = ({ useEffect(() => { if (d3Selection && d3Zoom) { - if (panOnScroll && !zoomActivationKeyPressed) { + if (panOnScroll && !zoomActivationKeyPressed && !userSelectionActive) { d3Selection.on('wheel.zoom', (event: any) => { if (isWrappedWithClass(event, noWheelClassName)) { return false; @@ -143,6 +143,7 @@ const ZoomPane = ({ } } }, [ + userSelectionActive, panOnScroll, panOnScrollMode, d3Selection, From da08e69e789af3e6f698d06e3a63139ac555d6a4 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Fri, 23 Sep 2022 15:35:28 +0100 Subject: [PATCH 04/35] feat: condense user selection into pane. --- .../src/components/UserSelection/index.tsx | 16 +++++++++---- .../core/src/container/FlowRenderer/index.tsx | 23 ++++++++++--------- 2 files changed, 24 insertions(+), 15 deletions(-) diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index cbf1e830..b39f10ab 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -18,6 +18,10 @@ type SelectionRect = Rect & { type UserSelectionProps = { selectionKeyPressed: boolean; + onClick?: (e: React.MouseEvent) => void; + onContextMenu?: (e: React.MouseEvent) => void; + onWheel?: (e: React.WheelEvent) => void; + children: React.ReactNode; }; function getMousePosition(event: React.MouseEvent, containerBounds: DOMRect): XYPosition { @@ -42,7 +46,7 @@ const initialRect: SelectionRect = { draw: false, }; -const UserSelection = memo(({ selectionKeyPressed }: UserSelectionProps) => { +const UserSelection = memo(({ selectionKeyPressed, onClick, onContextMenu, onWheel, children }: UserSelectionProps) => { const store = useStoreApi(); const prevSelectedNodesCount = useRef(0); const prevSelectedEdgesCount = useRef(0); @@ -80,8 +84,6 @@ const UserSelection = memo(({ selectionKeyPressed }: UserSelectionProps) => { y: mousePos.y, draw: true, }); - - store.setState({ userSelectionActive: true, nodesSelectionActive: false }); }; const onMouseMove = (event: React.MouseEvent): void => { @@ -89,6 +91,8 @@ const UserSelection = memo(({ selectionKeyPressed }: UserSelectionProps) => { return; } + store.setState({ userSelectionActive: true, nodesSelectionActive: false }); + const mousePos = getMousePosition(event, containerBounds.current!); const startX = userSelectionRect.startX ?? 0; const startY = userSelectionRect.startY ?? 0; @@ -138,12 +142,16 @@ const UserSelection = memo(({ selectionKeyPressed }: UserSelectionProps) => { return (
+ {children} {userSelectionRect.draw && (
- {children} - - {nodesSelectionActive && ( - - )} - + selectionKeyPressed={selectionKeyPressed || (selectBoxOnDrag && !panOnDrag)} + > + {children} + {nodesSelectionActive && ( + + )} + ); }; From 45c407755f184c877739e45fed3fc0b5abee5535 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Fri, 23 Sep 2022 16:06:24 +0100 Subject: [PATCH 05/35] feat: only click when not moved. --- packages/core/src/components/UserSelection/index.tsx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index b39f10ab..65cb1d2d 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -130,8 +130,13 @@ const UserSelection = memo(({ selectionKeyPressed, onClick, onContextMenu, onWhe setUserSelectionRect(nextUserSelectRect); }; - const onMouseUp = () => { + const onMouseUp = (event: React.MouseEvent) => { store.setState({ nodesSelectionActive: prevSelectedNodesCount.current > 0 }); + + if (!store.getState().userSelectionActive) { + onClick?.(event); + } + resetUserSelection(); }; @@ -147,7 +152,6 @@ const UserSelection = memo(({ selectionKeyPressed, onClick, onContextMenu, onWhe onMouseMove={onMouseMove} onMouseUp={onMouseUp} onMouseLeave={onMouseLeave} - onClick={onClick} onContextMenu={onContextMenu} onWheel={onWheel} > From 55811169da88ed740aef1fb2d854dc5065e0de80 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Fri, 23 Sep 2022 19:24:14 +0100 Subject: [PATCH 06/35] feat: handle selection mode properly. Up z-index for selection box. --- .../core/src/components/Nodes/wrapNode.tsx | 2 + .../src/components/UserSelection/index.tsx | 64 ++++++++----------- .../core/src/container/FlowRenderer/index.tsx | 6 +- packages/core/src/styles/init.css | 4 ++ 4 files changed, 38 insertions(+), 38 deletions(-) diff --git a/packages/core/src/components/Nodes/wrapNode.tsx b/packages/core/src/components/Nodes/wrapNode.tsx index afb1f761..1150c85d 100644 --- a/packages/core/src/components/Nodes/wrapNode.tsx +++ b/packages/core/src/components/Nodes/wrapNode.tsx @@ -81,6 +81,8 @@ export default (NodeComponent: ComponentType) => { const node = store.getState().nodeInternals.get(id)!; onClick(event, { ...node }); } + + event.stopPropagation(); }; const onKeyDown = (event: KeyboardEvent) => { diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index 65cb1d2d..d0aed2da 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -13,7 +13,6 @@ import type { XYPosition, ReactFlowState, NodeChange, EdgeChange, Rect } from '. type SelectionRect = Rect & { startX: number; startY: number; - draw: boolean; }; type UserSelectionProps = { @@ -36,32 +35,16 @@ const selector = (s: ReactFlowState) => ({ elementsSelectable: s.elementsSelectable, }); -const initialRect: SelectionRect = { - startX: 0, - startY: 0, - x: 0, - y: 0, - width: 0, - height: 0, - draw: false, -}; - const UserSelection = memo(({ selectionKeyPressed, onClick, onContextMenu, onWheel, children }: UserSelectionProps) => { const store = useStoreApi(); const prevSelectedNodesCount = useRef(0); const prevSelectedEdgesCount = useRef(0); const containerBounds = useRef(); - const [userSelectionRect, setUserSelectionRect] = useState(initialRect); + const [userSelectionRect, setUserSelectionRect] = useState(null); const { userSelectionActive, elementsSelectable } = useStore(selector, shallow); - const renderUserSelectionPane = userSelectionActive || selectionKeyPressed; - - if (!elementsSelectable || !renderUserSelectionPane) { - return null; - } - const resetUserSelection = () => { - setUserSelectionRect(initialRect); + setUserSelectionRect(null); store.setState({ userSelectionActive: false }); @@ -70,6 +53,10 @@ const UserSelection = memo(({ selectionKeyPressed, onClick, onContextMenu, onWhe }; const onMouseDown = (event: React.MouseEvent): void => { + if (!elementsSelectable || !selectionKeyPressed || event.button !== 0) { + return; + } + const reactFlowNode = (event.target as Element).closest('.react-flow')!; containerBounds.current = reactFlowNode.getBoundingClientRect(); @@ -82,12 +69,11 @@ const UserSelection = memo(({ selectionKeyPressed, onClick, onContextMenu, onWhe startY: mousePos.y, x: mousePos.x, y: mousePos.y, - draw: true, }); }; const onMouseMove = (event: React.MouseEvent): void => { - if (!selectionKeyPressed || !userSelectionRect.draw || !containerBounds.current) { + if (!selectionKeyPressed || !containerBounds.current || !userSelectionRect) { return; } @@ -103,6 +89,7 @@ const UserSelection = memo(({ selectionKeyPressed, onClick, onContextMenu, onWhe y: mousePos.y < startY ? mousePos.y : startY, width: Math.abs(mousePos.x - startX), height: Math.abs(mousePos.y - startY), + draw: true, }; const { nodeInternals, edges, transform, onNodesChange, onEdgesChange, nodeOrigin } = store.getState(); @@ -130,13 +117,9 @@ const UserSelection = memo(({ selectionKeyPressed, onClick, onContextMenu, onWhe setUserSelectionRect(nextUserSelectRect); }; - const onMouseUp = (event: React.MouseEvent) => { + const onMouseUp = () => { store.setState({ nodesSelectionActive: prevSelectedNodesCount.current > 0 }); - if (!store.getState().userSelectionActive) { - onClick?.(event); - } - resetUserSelection(); }; @@ -145,18 +128,27 @@ const UserSelection = memo(({ selectionKeyPressed, onClick, onContextMenu, onWhe resetUserSelection(); }; + const eventHandlers = + elementsSelectable && (selectionKeyPressed || userSelectionActive) + ? { + onClick, + onContextMenu, + onWheel, + onMouseDown, + onMouseMove, + onMouseUp, + onMouseLeave, + } + : { + onClick, + onContextMenu, + onWheel, + }; + return ( -
+
{children} - {userSelectionRect.draw && ( + {userSelectionActive && userSelectionRect && (
{ @@ -92,7 +94,7 @@ const FlowRenderer = ({ panOnScrollSpeed={panOnScrollSpeed} panOnScrollMode={panOnScrollMode} zoomOnDoubleClick={zoomOnDoubleClick} - panOnDrag={panOnDrag} + panOnDrag={panOnDrag && !isSelectionMode} defaultViewport={defaultViewport} translateExtent={translateExtent} minZoom={minZoom} @@ -109,7 +111,7 @@ const FlowRenderer = ({ onMouseLeave={onPaneMouseLeave} onContextMenu={onContextMenu} onWheel={onWheel} - selectionKeyPressed={selectionKeyPressed || (selectBoxOnDrag && !panOnDrag)} + selectionKeyPressed={isSelectionMode} > {children} {nodesSelectionActive && ( diff --git a/packages/core/src/styles/init.css b/packages/core/src/styles/init.css index a500c17d..6f4c25e8 100644 --- a/packages/core/src/styles/init.css +++ b/packages/core/src/styles/init.css @@ -30,6 +30,10 @@ z-index: 5; } +.react-flow__selection { + z-index: 6; +} + .react-flow__nodesselection-rect:focus, .react-flow__nodesselection-rect:focus-visible { outline: none; From 3169589fbc49fdd2d5e8175811844e44c38433fa Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Mon, 26 Sep 2022 15:08:51 +0100 Subject: [PATCH 07/35] feat: make sure 'panOnDrag' overrides 'selectBoxOnDrag'. --- packages/core/src/components/UserSelection/index.tsx | 10 +++++----- packages/core/src/container/FlowRenderer/index.tsx | 6 +++--- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index d0aed2da..e6435cd4 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -16,7 +16,7 @@ type SelectionRect = Rect & { }; type UserSelectionProps = { - selectionKeyPressed: boolean; + isSelectionMode: boolean; onClick?: (e: React.MouseEvent) => void; onContextMenu?: (e: React.MouseEvent) => void; onWheel?: (e: React.WheelEvent) => void; @@ -35,7 +35,7 @@ const selector = (s: ReactFlowState) => ({ elementsSelectable: s.elementsSelectable, }); -const UserSelection = memo(({ selectionKeyPressed, onClick, onContextMenu, onWheel, children }: UserSelectionProps) => { +const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, children }: UserSelectionProps) => { const store = useStoreApi(); const prevSelectedNodesCount = useRef(0); const prevSelectedEdgesCount = useRef(0); @@ -53,7 +53,7 @@ const UserSelection = memo(({ selectionKeyPressed, onClick, onContextMenu, onWhe }; const onMouseDown = (event: React.MouseEvent): void => { - if (!elementsSelectable || !selectionKeyPressed || event.button !== 0) { + if (!elementsSelectable || !isSelectionMode || event.button !== 0) { return; } @@ -73,7 +73,7 @@ const UserSelection = memo(({ selectionKeyPressed, onClick, onContextMenu, onWhe }; const onMouseMove = (event: React.MouseEvent): void => { - if (!selectionKeyPressed || !containerBounds.current || !userSelectionRect) { + if (!isSelectionMode || !containerBounds.current || !userSelectionRect) { return; } @@ -129,7 +129,7 @@ const UserSelection = memo(({ selectionKeyPressed, onClick, onContextMenu, onWhe }; const eventHandlers = - elementsSelectable && (selectionKeyPressed || userSelectionActive) + elementsSelectable && (isSelectionMode || userSelectionActive) ? { onClick, onContextMenu, diff --git a/packages/core/src/container/FlowRenderer/index.tsx b/packages/core/src/container/FlowRenderer/index.tsx index 5adc4d48..372fe762 100644 --- a/packages/core/src/container/FlowRenderer/index.tsx +++ b/packages/core/src/container/FlowRenderer/index.tsx @@ -69,7 +69,7 @@ const FlowRenderer = ({ const nodesSelectionActive = useStore(selector); const selectionKeyPressed = useKeyPress(selectionKeyCode); - const isSelectionMode = selectionKeyPressed || selectBoxOnDrag; + const isSelectionMode = selectionKeyPressed || (selectBoxOnDrag && !panOnDrag); useGlobalKeyHandler({ deleteKeyCode, multiSelectionKeyCode }); @@ -94,7 +94,7 @@ const FlowRenderer = ({ panOnScrollSpeed={panOnScrollSpeed} panOnScrollMode={panOnScrollMode} zoomOnDoubleClick={zoomOnDoubleClick} - panOnDrag={panOnDrag && !isSelectionMode} + panOnDrag={panOnDrag} defaultViewport={defaultViewport} translateExtent={translateExtent} minZoom={minZoom} @@ -111,7 +111,7 @@ const FlowRenderer = ({ onMouseLeave={onPaneMouseLeave} onContextMenu={onContextMenu} onWheel={onWheel} - selectionKeyPressed={isSelectionMode} + isSelectionMode={isSelectionMode} > {children} {nodesSelectionActive && ( From 920136b807b786b58b58aa46f3459d4895315953 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Mon, 26 Sep 2022 15:09:22 +0100 Subject: [PATCH 08/35] feat: add a Figma example. --- examples/vite-app/src/App/index.tsx | 6 ++ .../vite-app/src/examples/Figma/index.tsx | 97 +++++++++++++++++++ 2 files changed, 103 insertions(+) create mode 100644 examples/vite-app/src/examples/Figma/index.tsx diff --git a/examples/vite-app/src/App/index.tsx b/examples/vite-app/src/App/index.tsx index 5b596f48..8e46f457 100644 --- a/examples/vite-app/src/App/index.tsx +++ b/examples/vite-app/src/App/index.tsx @@ -13,6 +13,7 @@ import Edges from '../examples/Edges'; import EdgeRenderer from '../examples/EdgeRenderer'; import EdgeTypes from '../examples/EdgeTypes'; import Empty from '../examples/Empty'; +import Figma from '../examples/Figma'; import FloatingEdges from '../examples/FloatingEdges'; import Hidden from '../examples/Hidden'; import Interaction from '../examples/Interaction'; @@ -119,6 +120,11 @@ const routes: IRoute[] = [ path: '/empty', component: Empty, }, + { + name: 'Figma', + path: '/figma', + component: Figma, + }, { name: 'Floating Edges', path: '/floating-edges', diff --git a/examples/vite-app/src/examples/Figma/index.tsx b/examples/vite-app/src/examples/Figma/index.tsx new file mode 100644 index 00000000..3c19af29 --- /dev/null +++ b/examples/vite-app/src/examples/Figma/index.tsx @@ -0,0 +1,97 @@ +import ReactFlow, { + ReactFlowProvider, + Background, + BackgroundVariant, + Node, + Edge, + useReactFlow, + useKeyPress, +} from 'react-flow-renderer'; + +const MULTI_SELECT_KEY = ['Meta', 'Shift']; + +const initialNodes: Node[] = [ + { id: '1', type: 'input', data: { label: 'Node 1' }, position: { x: 250, y: 5 }, className: 'light' }, + { id: '2', data: { label: 'Node 2' }, position: { x: 100, y: 100 }, className: 'light' }, + { id: '3', data: { label: 'Node 3' }, position: { x: 400, y: 100 }, className: 'light' }, + { id: '4', data: { label: 'Node 4' }, position: { x: 400, y: 200 }, className: 'light' }, +]; + +const initialEdges: Edge[] = [ + { id: 'e1-2', source: '1', target: '2', animated: true }, + { id: 'e1-3', source: '1', target: '3' }, +]; + +const defaultEdgeOptions = { zIndex: 0 }; + +const BasicFlow = () => { + const instance = useReactFlow(); + const spaceBarPressed = useKeyPress('Space'); + + const updatePos = () => { + instance.setNodes((nodes) => + nodes.map((node) => { + node.position = { + x: Math.random() * 400, + y: Math.random() * 400, + }; + + return node; + }) + ); + }; + + const logToObject = () => console.log(instance.toObject()); + const resetTransform = () => instance.setViewport({ x: 0, y: 0, zoom: 1 }); + + const toggleClassnames = () => { + instance.setNodes((nodes) => + nodes.map((node) => { + node.className = node.className === 'light' ? 'dark' : 'light'; + + return node; + }) + ); + }; + + return ( + + + +
+ + + + +
+ + ); +}; + +export default function App() { + return ( + + + + ); +} From b65cc1229de124b729b519e406b818f306a0127e Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Mon, 26 Sep 2022 16:07:45 +0100 Subject: [PATCH 09/35] feat: add option for right click movement. --- packages/core/src/container/FlowRenderer/index.tsx | 10 ++++++++-- packages/core/src/container/ZoomPane/index.tsx | 14 +++++++++++++- packages/core/src/types/component-props.ts | 2 +- 3 files changed, 22 insertions(+), 4 deletions(-) diff --git a/packages/core/src/container/FlowRenderer/index.tsx b/packages/core/src/container/FlowRenderer/index.tsx index 372fe762..8956bc0c 100644 --- a/packages/core/src/container/FlowRenderer/index.tsx +++ b/packages/core/src/container/FlowRenderer/index.tsx @@ -69,7 +69,7 @@ const FlowRenderer = ({ const nodesSelectionActive = useStore(selector); const selectionKeyPressed = useKeyPress(selectionKeyCode); - const isSelectionMode = selectionKeyPressed || (selectBoxOnDrag && !panOnDrag); + const isSelectionMode = selectionKeyPressed || (selectBoxOnDrag && panOnDrag !== true); useGlobalKeyHandler({ deleteKeyCode, multiSelectionKeyCode }); @@ -79,7 +79,13 @@ const FlowRenderer = ({ store.setState({ nodesSelectionActive: false }); }; - const onContextMenu = onPaneContextMenu ? (event: MouseEvent) => onPaneContextMenu(event) : undefined; + const onContextMenu = (event: MouseEvent) => { + onPaneContextMenu?.(event); + + if (panOnDrag === 'RightClick') { + event.preventDefault(); + } + }; const onWheel = onPaneScroll ? (event: WheelEvent) => onPaneScroll(event) : undefined; return ( diff --git a/packages/core/src/container/ZoomPane/index.tsx b/packages/core/src/container/ZoomPane/index.tsx index c8050821..76547725 100644 --- a/packages/core/src/container/ZoomPane/index.tsx +++ b/packages/core/src/container/ZoomPane/index.tsx @@ -277,8 +277,20 @@ const ZoomPane = ({ return false; } + // if the pane is only movable using right clicks, prevent all other clicks + if ( + panOnDrag === 'RightClick' && + (event.type === 'mousedown' || event.type === 'touchstart') && + event.button !== 2 + ) { + return false; + } + + // We only allow right clicks if pan on drag is set to right click + const buttonAllowed = panOnDrag === 'RightClick' ? 1 !== event.button : !event.button || event.button <= 1; + // default filter for d3-zoom - return (!event.ctrlKey || event.type === 'wheel') && (!event.button || event.button <= 1); + return (!event.ctrlKey || event.type === 'wheel') && buttonAllowed; }); } }, [ diff --git a/packages/core/src/types/component-props.ts b/packages/core/src/types/component-props.ts index 456122ce..9cf390a7 100644 --- a/packages/core/src/types/component-props.ts +++ b/packages/core/src/types/component-props.ts @@ -108,7 +108,7 @@ export type ReactFlowProps = HTMLAttributes & { initNodeOrigin?: NodeOrigin; elementsSelectable?: boolean; selectNodesOnDrag?: boolean; - panOnDrag?: boolean; + panOnDrag?: boolean | 'RightClick'; minZoom?: number; maxZoom?: number; defaultViewport?: Viewport; From 86a0d7b5bab1e2ce3d1617ca75a4a5f028434623 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Mon, 26 Sep 2022 16:08:02 +0100 Subject: [PATCH 10/35] feat: update the example --- examples/vite-app/src/examples/Figma/index.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/vite-app/src/examples/Figma/index.tsx b/examples/vite-app/src/examples/Figma/index.tsx index 3c19af29..8330b936 100644 --- a/examples/vite-app/src/examples/Figma/index.tsx +++ b/examples/vite-app/src/examples/Figma/index.tsx @@ -59,7 +59,7 @@ const BasicFlow = () => { defaultNodes={initialNodes} defaultEdges={initialEdges} selectBoxOnDrag - panOnDrag={spaceBarPressed} + panOnDrag={spaceBarPressed ? true : 'RightClick'} panOnScroll zoomActivationKeyCode={'Meta'} multiSelectionKeyCode={MULTI_SELECT_KEY} From 00282c2cb49353f80f41b1bc646ec2a37cbbd2cd Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Mon, 26 Sep 2022 18:09:37 +0100 Subject: [PATCH 11/35] feat: only trigger a pane 'click' if there is no movement. --- packages/core/src/components/UserSelection/index.tsx | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index e6435cd4..fbcc9974 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -117,7 +117,13 @@ const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, setUserSelectionRect(nextUserSelectRect); }; - const onMouseUp = () => { + const onMouseUp = (event: React.MouseEvent) => { + // We only want to trigger click functions when in selection mode if + // the user did not move the mouse. + if (!userSelectionActive && userSelectionRect) { + onClick?.(event); + } + store.setState({ nodesSelectionActive: prevSelectedNodesCount.current > 0 }); resetUserSelection(); @@ -131,7 +137,6 @@ const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, const eventHandlers = elementsSelectable && (isSelectionMode || userSelectionActive) ? { - onClick, onContextMenu, onWheel, onMouseDown, From 3969544fdfa20d8bdc7ba6e55a16e783140f984f Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Mon, 26 Sep 2022 18:21:32 +0100 Subject: [PATCH 12/35] feat: do not clear the selection when you mouse out. --- packages/core/src/components/UserSelection/index.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index fbcc9974..00c744f1 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -130,7 +130,7 @@ const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, }; const onMouseLeave = () => { - store.setState({ nodesSelectionActive: false }); + store.setState({ nodesSelectionActive: prevSelectedNodesCount.current > 0 }); resetUserSelection(); }; From e22938b49f6e61522671eb43155dd52b09fcb547 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Tue, 27 Sep 2022 10:22:00 +0100 Subject: [PATCH 13/35] feat: do not remove node selection on leave. --- packages/core/src/components/UserSelection/index.tsx | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index 00c744f1..ebf23348 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -130,7 +130,6 @@ const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, }; const onMouseLeave = () => { - store.setState({ nodesSelectionActive: prevSelectedNodesCount.current > 0 }); resetUserSelection(); }; From a1c830c0865ac88bf88d8c441dae480f77b39e19 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Tue, 27 Sep 2022 10:45:25 +0100 Subject: [PATCH 14/35] feat: make sure 'onPaneContextMenu' still works with panOnDrag = 'RightClick'. --- .../core/src/container/FlowRenderer/index.tsx | 5 +++-- .../core/src/container/ZoomPane/index.tsx | 19 +++++++++++++++++-- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/packages/core/src/container/FlowRenderer/index.tsx b/packages/core/src/container/FlowRenderer/index.tsx index 8956bc0c..887124cb 100644 --- a/packages/core/src/container/FlowRenderer/index.tsx +++ b/packages/core/src/container/FlowRenderer/index.tsx @@ -80,10 +80,10 @@ const FlowRenderer = ({ }; const onContextMenu = (event: MouseEvent) => { - onPaneContextMenu?.(event); - if (panOnDrag === 'RightClick') { event.preventDefault(); + } else { + onPaneContextMenu?.(event); } }; const onWheel = onPaneScroll ? (event: WheelEvent) => onPaneScroll(event) : undefined; @@ -93,6 +93,7 @@ const FlowRenderer = ({ onMove={onMove} onMoveStart={onMoveStart} onMoveEnd={onMoveEnd} + onPaneContextMenu={onPaneContextMenu} elementsSelectable={elementsSelectable} zoomOnScroll={zoomOnScroll} zoomOnPinch={zoomOnPinch} diff --git a/packages/core/src/container/ZoomPane/index.tsx b/packages/core/src/container/ZoomPane/index.tsx index 76547725..5179f104 100644 --- a/packages/core/src/container/ZoomPane/index.tsx +++ b/packages/core/src/container/ZoomPane/index.tsx @@ -46,6 +46,7 @@ const ZoomPane = ({ onMove, onMoveStart, onMoveEnd, + onPaneContextMenu, zoomOnScroll = true, zoomOnPinch = true, panOnScroll = false, @@ -67,6 +68,7 @@ const ZoomPane = ({ const timerId = useRef>(); const store = useStoreApi(); const isZoomingOrPanning = useRef(false); + const hasMouseMoved = useRef(false); const zoomPane = useRef(null); const prevTransform = useRef({ x: 0, y: 0, zoom: 0 }); const { d3Zoom, d3Selection, d3ZoomHandler, userSelectionActive } = useStore(selector, shallow); @@ -171,10 +173,13 @@ const ZoomPane = ({ onViewportChange?.(flowTransform); onMove?.(event.sourceEvent as MouseEvent | TouchEvent, flowTransform); } + if (panOnDrag === 'RightClick' && onPaneContextMenu) { + hasMouseMoved.current = true; + } }); } } - }, [userSelectionActive, d3Zoom, onMove]); + }, [userSelectionActive, d3Zoom, onMove, panOnDrag, onPaneContextMenu]); useEffect(() => { if (d3Zoom) { @@ -224,9 +229,19 @@ const ZoomPane = ({ panOnScroll ? 150 : 0 ); } + + if ( + panOnDrag === 'RightClick' && + onPaneContextMenu && + !hasMouseMoved.current && + event.sourceEvent?.button === 2 + ) { + onPaneContextMenu(event.sourceEvent); + } + hasMouseMoved.current = false; }); } - }, [d3Zoom, onMoveEnd, panOnScroll]); + }, [d3Zoom, onMoveEnd, panOnScroll, panOnDrag, onPaneContextMenu]); useEffect(() => { if (d3Zoom) { From b47824393174f324e20bc07cadda8a0e4707f5f4 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Tue, 27 Sep 2022 10:46:17 +0100 Subject: [PATCH 15/35] chore: add onPaneContextMenu to figma example. --- examples/vite-app/src/examples/Figma/index.tsx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/examples/vite-app/src/examples/Figma/index.tsx b/examples/vite-app/src/examples/Figma/index.tsx index 8330b936..e1365ec4 100644 --- a/examples/vite-app/src/examples/Figma/index.tsx +++ b/examples/vite-app/src/examples/Figma/index.tsx @@ -24,6 +24,8 @@ const initialEdges: Edge[] = [ const defaultEdgeOptions = { zIndex: 0 }; +const logEvent = (e: any) => console.log(e); + const BasicFlow = () => { const instance = useReactFlow(); const spaceBarPressed = useKeyPress('Space'); @@ -61,6 +63,7 @@ const BasicFlow = () => { selectBoxOnDrag panOnDrag={spaceBarPressed ? true : 'RightClick'} panOnScroll + onPaneContextMenu={logEvent} zoomActivationKeyCode={'Meta'} multiSelectionKeyCode={MULTI_SELECT_KEY} className="react-flow-basic-example" From a2eff8f834fc2509b2de684ed594406501acc38b Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Tue, 27 Sep 2022 11:02:29 +0100 Subject: [PATCH 16/35] feat: clear selection when starting new selection. --- packages/core/src/components/UserSelection/index.tsx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index ebf23348..fc9ab9fc 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -57,6 +57,8 @@ const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, return; } + store.getState().resetSelectedElements(); + const reactFlowNode = (event.target as Element).closest('.react-flow')!; containerBounds.current = reactFlowNode.getBoundingClientRect(); From 45dfcfd4eebc5bf2b2ceafbda1bdb2f1428e61c4 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Tue, 27 Sep 2022 11:10:34 +0100 Subject: [PATCH 17/35] feat: don't ignore user selection on mouse leave as we may have selected nodes. --- packages/core/src/components/UserSelection/index.tsx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index fc9ab9fc..0c0e871a 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -132,6 +132,9 @@ const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, }; const onMouseLeave = () => { + if (userSelectionActive) { + store.setState({ nodesSelectionActive: prevSelectedNodesCount.current > 0 }); + } resetUserSelection(); }; From f0baf6472542ac7fb2016976b99c3b5da1043e53 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Tue, 27 Sep 2022 15:03:02 +0100 Subject: [PATCH 18/35] bug fix: only handle mouse events that were targeted at the selection pane. --- .../core/src/components/Nodes/wrapNode.tsx | 2 - .../src/components/UserSelection/index.tsx | 45 ++++++++++++++----- 2 files changed, 34 insertions(+), 13 deletions(-) diff --git a/packages/core/src/components/Nodes/wrapNode.tsx b/packages/core/src/components/Nodes/wrapNode.tsx index 1150c85d..afb1f761 100644 --- a/packages/core/src/components/Nodes/wrapNode.tsx +++ b/packages/core/src/components/Nodes/wrapNode.tsx @@ -81,8 +81,6 @@ export default (NodeComponent: ComponentType) => { const node = store.getState().nodeInternals.get(id)!; onClick(event, { ...node }); } - - event.stopPropagation(); }; const onKeyDown = (event: KeyboardEvent) => { diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index 0c0e871a..152e7115 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -15,6 +15,8 @@ type SelectionRect = Rect & { startY: number; }; +type EventHandlers = { [key: string]: React.MouseEventHandler | React.WheelEventHandler | undefined }; + type UserSelectionProps = { isSelectionMode: boolean; onClick?: (e: React.MouseEvent) => void; @@ -30,12 +32,31 @@ function getMousePosition(event: React.MouseEvent, containerBounds: DOMRect): XY }; } +const wrapHandler = ( + handler: React.MouseEventHandler | undefined, + containerRef: React.MutableRefObject +): React.MouseEventHandler => { + return (event: React.MouseEvent) => { + if (event.target !== containerRef.current) { + return; + } + handler?.(event); + }; +}; + +const wrapHandlers = ( + handlers: EventHandlers, + containerRef: React.MutableRefObject +): EventHandlers => + Object.keys(handlers).reduce((hls, key) => ({ ...hls, [key]: wrapHandler(handlers[key], containerRef) }), {}); + const selector = (s: ReactFlowState) => ({ userSelectionActive: s.userSelectionActive, elementsSelectable: s.elementsSelectable, }); const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, children }: UserSelectionProps) => { + const container = useRef(null); const store = useStoreApi(); const prevSelectedNodesCount = useRef(0); const prevSelectedEdgesCount = useRef(0); @@ -53,7 +74,7 @@ const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, }; const onMouseDown = (event: React.MouseEvent): void => { - if (!elementsSelectable || !isSelectionMode || event.button !== 0) { + if (!elementsSelectable || !isSelectionMode || event.button !== 0 || event.target !== container.current) { return; } @@ -75,7 +96,7 @@ const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, }; const onMouseMove = (event: React.MouseEvent): void => { - if (!isSelectionMode || !containerBounds.current || !userSelectionRect) { + if (!isSelectionMode || !containerBounds.current || !userSelectionRect || event.target !== container.current) { return; } @@ -122,7 +143,7 @@ const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, const onMouseUp = (event: React.MouseEvent) => { // We only want to trigger click functions when in selection mode if // the user did not move the mouse. - if (!userSelectionActive && userSelectionRect) { + if (!userSelectionActive && userSelectionRect && event.target === container.current) { onClick?.(event); } @@ -141,21 +162,23 @@ const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, const eventHandlers = elementsSelectable && (isSelectionMode || userSelectionActive) ? { - onContextMenu, - onWheel, + ...wrapHandlers({ onContextMenu, onWheel }, container), onMouseDown, onMouseMove, onMouseUp, onMouseLeave, } - : { - onClick, - onContextMenu, - onWheel, - }; + : wrapHandlers( + { + onClick, + onContextMenu, + onWheel, + }, + container + ); return ( -
+
{children} {userSelectionActive && userSelectionRect && (
Date: Tue, 27 Sep 2022 15:03:24 +0100 Subject: [PATCH 19/35] bug fix: do not panOnDrag if the selection button is pressed. --- packages/core/src/container/FlowRenderer/index.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/src/container/FlowRenderer/index.tsx b/packages/core/src/container/FlowRenderer/index.tsx index 887124cb..ae501b46 100644 --- a/packages/core/src/container/FlowRenderer/index.tsx +++ b/packages/core/src/container/FlowRenderer/index.tsx @@ -101,7 +101,7 @@ const FlowRenderer = ({ panOnScrollSpeed={panOnScrollSpeed} panOnScrollMode={panOnScrollMode} zoomOnDoubleClick={zoomOnDoubleClick} - panOnDrag={panOnDrag} + panOnDrag={panOnDrag && !selectionKeyPressed} defaultViewport={defaultViewport} translateExtent={translateExtent} minZoom={minZoom} From 3c94b22ac1c73209d396958f910dac64fa997d25 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Tue, 27 Sep 2022 15:22:56 +0100 Subject: [PATCH 20/35] bug fix: fix not panning on selection button press. --- packages/core/src/container/FlowRenderer/index.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/src/container/FlowRenderer/index.tsx b/packages/core/src/container/FlowRenderer/index.tsx index ae501b46..d203033b 100644 --- a/packages/core/src/container/FlowRenderer/index.tsx +++ b/packages/core/src/container/FlowRenderer/index.tsx @@ -101,7 +101,7 @@ const FlowRenderer = ({ panOnScrollSpeed={panOnScrollSpeed} panOnScrollMode={panOnScrollMode} zoomOnDoubleClick={zoomOnDoubleClick} - panOnDrag={panOnDrag && !selectionKeyPressed} + panOnDrag={!selectionKeyPressed && panOnDrag} defaultViewport={defaultViewport} translateExtent={translateExtent} minZoom={minZoom} From 44097c15c99ebbb03b20171082a2b5884c6dc987 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Tue, 27 Sep 2022 18:28:53 +0100 Subject: [PATCH 21/35] tests: start fixing cypress tests. --- examples/vite-app/cypress/e2e/basic.cy.ts | 222 +++++++++--------- examples/vite-app/cypress/e2e/controls.cy.ts | 2 +- examples/vite-app/cypress/e2e/empty.cy.ts | 6 +- .../vite-app/cypress/e2e/interaction.cy.ts | 2 +- examples/vite-app/cypress/e2e/minimap.cy.ts | 2 +- .../src/components/UserSelection/index.tsx | 2 +- packages/core/src/styles/init.css | 2 +- 7 files changed, 119 insertions(+), 119 deletions(-) diff --git a/examples/vite-app/cypress/e2e/basic.cy.ts b/examples/vite-app/cypress/e2e/basic.cy.ts index a08ca021..3aa5406d 100644 --- a/examples/vite-app/cypress/e2e/basic.cy.ts +++ b/examples/vite-app/cypress/e2e/basic.cy.ts @@ -11,86 +11,86 @@ describe('Basic Flow Rendering', () => { cy.get('.react-flow__node').children('.react-flow__handle'); }); - it('renders a grid', () => { - cy.get('.react-flow__background'); - }); + // it('renders a grid', () => { + // cy.get('.react-flow__background'); + // }); - it('selects two nodes by clicks', () => { - cy.get('body').type('{cmd}', { release: false }); - cy.get('.react-flow__node:first') - .click() - .should('have.class', 'selected') - .get('.react-flow__node:last') - .click() - .should('have.class', 'selected') - .get('.react-flow__node:first') - .should('have.class', 'selected'); - cy.get('body').type('{cmd}', { release: true }); - }); + // it('selects two nodes by clicks', () => { + // cy.get('body').type('{cmd}', { release: false }); + // cy.get('.react-flow__node:first') + // .click() + // .should('have.class', 'selected') + // .get('.react-flow__node:last') + // .click() + // .should('have.class', 'selected') + // .get('.react-flow__node:first') + // .should('have.class', 'selected'); + // cy.get('body').type('{cmd}', { release: true }); + // }); - it('selects a node by click', () => { - cy.get('.react-flow__node:first').click({ force: true }).should('have.class', 'selected'); - }); + // it('selects a node by click', () => { + // cy.get('.react-flow__node:first').click({ force: true }).should('have.class', 'selected'); + // }); - it('deselects node', () => { - cy.get('.react-flow__renderer').click('bottomLeft'); - cy.get('.react-flow__node:first').should('not.have.class', 'selected'); - }); + // it('deselects node', () => { + // cy.get('.react-flow__renderer').click('bottomLeft'); + // cy.get('.react-flow__node:first').should('not.have.class', 'selected'); + // }); - it('selects an edge by click', () => { - cy.get('.react-flow__edge:first').click({ force: true }).should('have.class', 'selected'); - }); + // it('selects an edge by click', () => { + // cy.get('.react-flow__edge:first').click({ force: true }).should('have.class', 'selected'); + // }); - it('deselects edge', () => { - cy.get('.react-flow__renderer').click('bottomLeft'); - cy.get('.react-flow__edge:first').should('not.have.class', 'selected'); - }); + // it('deselects edge', () => { + // cy.get('.react-flow__renderer').click('bottomLeft'); + // cy.get('.react-flow__edge:first').should('not.have.class', 'selected'); + // }); - it('selects one node with a selection', () => { - cy.get('body') - .type('{shift}', { release: false }) - .wait(50) - .get('.react-flow__selectionpane') - .trigger('mousedown', 1000, 50, { which: 1, force: true }) - .trigger('mousemove', 1, 400, { which: 1 }) - .wait(50) - .trigger('mouseup', 1, 200, { force: true }); + // it('selects one node with a selection', () => { + // cy.get('body') + // .type('{shift}', { release: false }) + // .wait(50) + // .get('.react-flow__pane') + // .trigger('mousedown', 1000, 50, { button: 0, force: true }) + // .trigger('mousemove', 1, 400, { button: 0 }) + // .wait(50) + // .trigger('mouseup', 1, 200, { force: true }); - cy.wait(100); + // cy.wait(100); - cy.get('.react-flow__node').eq(1).should('have.class', 'selected'); + // cy.get('.react-flow__node').eq(1).should('have.class', 'selected'); - cy.get('.react-flow__node').eq(0).should('have.not.class', 'selected'); + // cy.get('.react-flow__node').eq(0).should('have.not.class', 'selected'); - cy.get('.react-flow__nodesselection-rect'); + // cy.get('.react-flow__nodesselection-rect'); - cy.get('body').type('{shift}', { release: true, force: true }); - }); + // cy.get('body').type('{shift}', { release: true, force: true }); + // }); - it('selects all nodes', () => { - cy.get('body') - .type('{shift}', { release: false }) - .get('.react-flow__selectionpane') - .trigger('mousedown', 'topRight', { which: 1, force: true }) - .trigger('mousemove', 'bottomLeft', { which: 1 }) - .wait(50) - .trigger('mouseup', 'bottomLeft', { force: true }) - .wait(50) - .get('.react-flow__node') - .should('have.class', 'selected') - .get('.react-flow__nodesselection-rect'); + // it('selects all nodes', () => { + // cy.get('body') + // .type('{shift}', { release: false }) + // .get('.react-flow__pane') + // .trigger('mousedown', 'topRight', { button: 0, force: true }) + // .trigger('mousemove', 'bottomLeft', { button: 0 }) + // .wait(50) + // .trigger('mouseup', 'bottomLeft', { force: true }) + // .wait(50) + // .get('.react-flow__node') + // .should('have.class', 'selected') + // .get('.react-flow__nodesselection-rect'); - cy.get('body').type('{shift}', { release: true }); - }); + // cy.get('body').type('{shift}', { release: true }); + // }); - it('removes selection', () => { - cy.get('.react-flow__renderer').click('bottomLeft'); - cy.get('.react-flow__nodesselection-rect').should('not.exist'); - }); + // it('removes selection', () => { + // cy.get('.react-flow__renderer').click('bottomLeft'); + // cy.get('.react-flow__nodesselection-rect').should('not.exist'); + // }); - it('selects an edge', () => { - cy.get('.react-flow__edge:first').click({ force: true }).should('have.class', 'selected'); - }); + // it('selects an edge', () => { + // cy.get('.react-flow__edge:first').click({ force: true }).should('have.class', 'selected'); + // }); it('drags a node', () => { const styleBeforeDrag = Cypress.$('.react-flow__node:first').css('transform'); @@ -109,59 +109,59 @@ describe('Basic Flow Rendering', () => { // cy.get('.react-flow__edge').should('have.length', 1); // }); - it('connects nodes', () => { - cy.get('.react-flow__node') - .contains('Node 3') - .find('.react-flow__handle.source') - .trigger('mousedown', { button: 0 }); + // it('connects nodes', () => { + // cy.get('.react-flow__node') + // .contains('Node 3') + // .find('.react-flow__handle.source') + // .trigger('mousedown', { button: 0 }); - cy.get('.react-flow__node') - .contains('Node 4') - .find('.react-flow__handle.target') - .trigger('mousemove', { force: true }) - .wait(50) - .trigger('mouseup', { force: true }); + // cy.get('.react-flow__node') + // .contains('Node 4') + // .find('.react-flow__handle.target') + // .trigger('mousemove', { force: true }) + // .wait(50) + // .trigger('mouseup', { force: true }); - cy.get('.react-flow__edge').should('have.length', 3); - }); - - // @TODO: why does this fail since react18? - // it('removes an edge', () => { - // cy.get('.react-flow__edge:first').click(); - // cy.get('body').type('{backspace}'); - - // cy.get('.react-flow__edge').should('have.length', 1); + // cy.get('.react-flow__edge').should('have.length', 3); // }); - it('drags the pane', () => { - const styleBeforeDrag = Cypress.$('.react-flow__viewport').css('transform'); + // // @TODO: why does this fail since react18? + // // it('removes an edge', () => { + // // cy.get('.react-flow__edge:first').click(); + // // cy.get('body').type('{backspace}'); - // for d3 we have to pass the window to the event - // https://github.com/cypress-io/cypress/issues/3441 - cy.window().then((win) => { - cy.get('.react-flow__pane') - .trigger('mousedown', 'topLeft', { which: 1, view: win }) - .trigger('mousemove', 'bottomLeft') - .wait(50) - .trigger('mouseup', { force: true, view: win }) - .then(() => { - const styleAfterDrag = Cypress.$('.react-flow__viewport').css('transform'); - expect(styleBeforeDrag).to.not.equal(styleAfterDrag); - }); - }); - }); + // // cy.get('.react-flow__edge').should('have.length', 1); + // // }); - it('zooms the pane', () => { - const styleBeforeZoom = Cypress.$('.react-flow__viewport').css('transform'); + // it('drags the pane', () => { + // const styleBeforeDrag = Cypress.$('.react-flow__viewport').css('transform'); - cy.get('.react-flow__pane') - .trigger('wheel', 'topLeft', { deltaY: -200 }) - .wait(50) - .then(() => { - const styleAfterZoom = Cypress.$('.react-flow__viewport').css('transform'); - expect(styleBeforeZoom).to.not.equal(styleAfterZoom); - }); - }); + // // for d3 we have to pass the window to the event + // // https://github.com/cypress-io/cypress/issues/3441 + // cy.window().then((win) => { + // cy.get('.react-flow__pane') + // .trigger('mousedown', 'topLeft', { button: 0, view: win }) + // .trigger('mousemove', 'bottomLeft') + // .wait(50) + // .trigger('mouseup', { force: true, view: win }) + // .then(() => { + // const styleAfterDrag = Cypress.$('.react-flow__viewport').css('transform'); + // expect(styleBeforeDrag).to.not.equal(styleAfterDrag); + // }); + // }); + // }); + + // it('zooms the pane', () => { + // const styleBeforeZoom = Cypress.$('.react-flow__viewport').css('transform'); + + // cy.get('.react-flow__pane') + // .trigger('wheel', 'topLeft', { deltaY: -200 }) + // .wait(50) + // .then(() => { + // const styleAfterZoom = Cypress.$('.react-flow__viewport').css('transform'); + // expect(styleBeforeZoom).to.not.equal(styleAfterZoom); + // }); + // }); }); export {}; diff --git a/examples/vite-app/cypress/e2e/controls.cy.ts b/examples/vite-app/cypress/e2e/controls.cy.ts index 74548f56..07d0548e 100644 --- a/examples/vite-app/cypress/e2e/controls.cy.ts +++ b/examples/vite-app/cypress/e2e/controls.cy.ts @@ -37,7 +37,7 @@ describe('Controls Testing', () => { // https://github.com/cypress-io/cypress/issues/3441 cy.window().then((win) => { cy.get('.react-flow__renderer') - .trigger('mousedown', 'topLeft', { which: 1, view: win }) + .trigger('mousedown', 'topLeft', { button: 0, view: win }) .trigger('mousemove', 10, 400) .wait(50) .trigger('mouseup', 10, 400, { force: true, view: win }) diff --git a/examples/vite-app/cypress/e2e/empty.cy.ts b/examples/vite-app/cypress/e2e/empty.cy.ts index 5f25dcaf..74cba86d 100644 --- a/examples/vite-app/cypress/e2e/empty.cy.ts +++ b/examples/vite-app/cypress/e2e/empty.cy.ts @@ -14,9 +14,9 @@ describe('Empty Flow Rendering', () => { cy.get('body') .type('{shift}', { release: false }) .wait(50) - .get('.react-flow__selectionpane') - .trigger('mousedown', 400, 50, { which: 1, force: true }) - .trigger('mousemove', 200, 200, { which: 1 }) + .get('.react-flow__pane') + .trigger('mousedown', 400, 50, { button: 0, force: true }) + .trigger('mousemove', 200, 200, { button: 0 }) .wait(50) .trigger('mouseup', 200, 200, { force: true }); diff --git a/examples/vite-app/cypress/e2e/interaction.cy.ts b/examples/vite-app/cypress/e2e/interaction.cy.ts index 625ecc57..edfe6f11 100644 --- a/examples/vite-app/cypress/e2e/interaction.cy.ts +++ b/examples/vite-app/cypress/e2e/interaction.cy.ts @@ -35,7 +35,7 @@ describe('Interaction Flow Rendering', () => { }); it('tries to do a selection', () => { - cy.get('body').type('{shift}', { release: false }).get('.react-flow__selectionpane').should('not.exist'); + cy.get('body').type('{shift}', { release: false }).get('.react-flow__pane').should('not.exist'); cy.get('body').type('{shift}', { release: true }); }); diff --git a/examples/vite-app/cypress/e2e/minimap.cy.ts b/examples/vite-app/cypress/e2e/minimap.cy.ts index d6cb7d46..e6f4e3eb 100644 --- a/examples/vite-app/cypress/e2e/minimap.cy.ts +++ b/examples/vite-app/cypress/e2e/minimap.cy.ts @@ -57,7 +57,7 @@ describe('Minimap Testing', () => { // https://github.com/cypress-io/cypress/issues/3441 cy.window().then((win) => { cy.get('.react-flow__pane') - .trigger('mousedown', 'topLeft', { which: 1, view: win }) + .trigger('mousedown', 'topLeft', { button: 0, view: win }) .trigger('mousemove', 'bottomLeft') .wait(50) .trigger('mouseup', { force: true, view: win }) diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index 152e7115..44deca7c 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -178,7 +178,7 @@ const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, ); return ( -
+
{children} {userSelectionActive && userSelectionRect && (
Date: Wed, 28 Sep 2022 10:55:10 +0100 Subject: [PATCH 22/35] tests: fix basics cypress test. --- examples/vite-app/cypress/e2e/basic.cy.ts | 222 +++++++++++----------- 1 file changed, 111 insertions(+), 111 deletions(-) diff --git a/examples/vite-app/cypress/e2e/basic.cy.ts b/examples/vite-app/cypress/e2e/basic.cy.ts index 3aa5406d..fd4c107a 100644 --- a/examples/vite-app/cypress/e2e/basic.cy.ts +++ b/examples/vite-app/cypress/e2e/basic.cy.ts @@ -11,86 +11,86 @@ describe('Basic Flow Rendering', () => { cy.get('.react-flow__node').children('.react-flow__handle'); }); - // it('renders a grid', () => { - // cy.get('.react-flow__background'); - // }); + it('renders a grid', () => { + cy.get('.react-flow__background'); + }); - // it('selects two nodes by clicks', () => { - // cy.get('body').type('{cmd}', { release: false }); - // cy.get('.react-flow__node:first') - // .click() - // .should('have.class', 'selected') - // .get('.react-flow__node:last') - // .click() - // .should('have.class', 'selected') - // .get('.react-flow__node:first') - // .should('have.class', 'selected'); - // cy.get('body').type('{cmd}', { release: true }); - // }); + it('selects two nodes by clicks', () => { + cy.get('body').type('{cmd}', { release: false }); + cy.get('.react-flow__node:first') + .click() + .should('have.class', 'selected') + .get('.react-flow__node:last') + .click() + .should('have.class', 'selected') + .get('.react-flow__node:first') + .should('have.class', 'selected'); + cy.get('body').type('{cmd}', { release: true }); + }); - // it('selects a node by click', () => { - // cy.get('.react-flow__node:first').click({ force: true }).should('have.class', 'selected'); - // }); + it('selects a node by click', () => { + cy.get('.react-flow__node:first').click({ force: true }).should('have.class', 'selected'); + }); - // it('deselects node', () => { - // cy.get('.react-flow__renderer').click('bottomLeft'); - // cy.get('.react-flow__node:first').should('not.have.class', 'selected'); - // }); + it('deselects node', () => { + cy.get('.react-flow__renderer').click('bottomLeft'); + cy.get('.react-flow__node:first').should('not.have.class', 'selected'); + }); - // it('selects an edge by click', () => { - // cy.get('.react-flow__edge:first').click({ force: true }).should('have.class', 'selected'); - // }); + it('selects an edge by click', () => { + cy.get('.react-flow__edge:first').click({ force: true }).should('have.class', 'selected'); + }); - // it('deselects edge', () => { - // cy.get('.react-flow__renderer').click('bottomLeft'); - // cy.get('.react-flow__edge:first').should('not.have.class', 'selected'); - // }); + it('deselects edge', () => { + cy.get('.react-flow__renderer').click('bottomLeft'); + cy.get('.react-flow__edge:first').should('not.have.class', 'selected'); + }); - // it('selects one node with a selection', () => { - // cy.get('body') - // .type('{shift}', { release: false }) - // .wait(50) - // .get('.react-flow__pane') - // .trigger('mousedown', 1000, 50, { button: 0, force: true }) - // .trigger('mousemove', 1, 400, { button: 0 }) - // .wait(50) - // .trigger('mouseup', 1, 200, { force: true }); + it('selects one node with a selection', () => { + cy.get('body') + .type('{shift}', { release: false }) + .wait(50) + .get('.react-flow__pane') + .trigger('mousedown', 1000, 50, { button: 0, force: true }) + .trigger('mousemove', 1, 400, { button: 0 }) + .wait(50) + .trigger('mouseup', 1, 200, { force: true }); - // cy.wait(100); + cy.wait(100); - // cy.get('.react-flow__node').eq(1).should('have.class', 'selected'); + cy.get('.react-flow__node').eq(1).should('have.class', 'selected'); - // cy.get('.react-flow__node').eq(0).should('have.not.class', 'selected'); + cy.get('.react-flow__node').eq(0).should('have.not.class', 'selected'); - // cy.get('.react-flow__nodesselection-rect'); + cy.get('.react-flow__nodesselection-rect'); - // cy.get('body').type('{shift}', { release: true, force: true }); - // }); + cy.get('body').type('{shift}', { release: true, force: true }); + }); - // it('selects all nodes', () => { - // cy.get('body') - // .type('{shift}', { release: false }) - // .get('.react-flow__pane') - // .trigger('mousedown', 'topRight', { button: 0, force: true }) - // .trigger('mousemove', 'bottomLeft', { button: 0 }) - // .wait(50) - // .trigger('mouseup', 'bottomLeft', { force: true }) - // .wait(50) - // .get('.react-flow__node') - // .should('have.class', 'selected') - // .get('.react-flow__nodesselection-rect'); + it('selects all nodes', () => { + cy.get('body') + .type('{shift}', { release: false }) + .get('.react-flow__pane') + .trigger('mousedown', 'topRight', { button: 0, force: true }) + .trigger('mousemove', 'bottomLeft', { button: 0 }) + .wait(50) + .trigger('mouseup', 'bottomLeft', { force: true }) + .wait(50) + .get('.react-flow__node') + .should('have.class', 'selected') + .get('.react-flow__nodesselection-rect'); - // cy.get('body').type('{shift}', { release: true }); - // }); + cy.get('body').type('{shift}', { release: true }); + }); - // it('removes selection', () => { - // cy.get('.react-flow__renderer').click('bottomLeft'); - // cy.get('.react-flow__nodesselection-rect').should('not.exist'); - // }); + it('removes selection', () => { + cy.get('.react-flow__renderer').click('bottomLeft'); + cy.get('.react-flow__nodesselection-rect').should('not.exist'); + }); - // it('selects an edge', () => { - // cy.get('.react-flow__edge:first').click({ force: true }).should('have.class', 'selected'); - // }); + it('selects an edge', () => { + cy.get('.react-flow__edge:first').click({ force: true }).should('have.class', 'selected'); + }); it('drags a node', () => { const styleBeforeDrag = Cypress.$('.react-flow__node:first').css('transform'); @@ -109,59 +109,59 @@ describe('Basic Flow Rendering', () => { // cy.get('.react-flow__edge').should('have.length', 1); // }); - // it('connects nodes', () => { - // cy.get('.react-flow__node') - // .contains('Node 3') - // .find('.react-flow__handle.source') - // .trigger('mousedown', { button: 0 }); + it('connects nodes', () => { + cy.get('.react-flow__node') + .contains('Node 3') + .find('.react-flow__handle.source') + .trigger('mousedown', { button: 0 }); - // cy.get('.react-flow__node') - // .contains('Node 4') - // .find('.react-flow__handle.target') - // .trigger('mousemove', { force: true }) - // .wait(50) - // .trigger('mouseup', { force: true }); + cy.get('.react-flow__node') + .contains('Node 4') + .find('.react-flow__handle.target') + .trigger('mousemove', { force: true }) + .wait(50) + .trigger('mouseup', { force: true }); - // cy.get('.react-flow__edge').should('have.length', 3); + cy.get('.react-flow__edge').should('have.length', 3); + }); + + // @TODO: why does this fail since react18? + // it('removes an edge', () => { + // cy.get('.react-flow__edge:first').click(); + // cy.get('body').type('{backspace}'); + + // cy.get('.react-flow__edge').should('have.length', 1); // }); - // // @TODO: why does this fail since react18? - // // it('removes an edge', () => { - // // cy.get('.react-flow__edge:first').click(); - // // cy.get('body').type('{backspace}'); + it('drags the pane', () => { + const styleBeforeDrag = Cypress.$('.react-flow__viewport').css('transform'); - // // cy.get('.react-flow__edge').should('have.length', 1); - // // }); + // for d3 we have to pass the window to the event + // https://github.com/cypress-io/cypress/issues/3441 + cy.window().then((win) => { + cy.get('.react-flow__pane') + .trigger('mousedown', 'topLeft', { button: 0, view: win }) + .trigger('mousemove', 'bottomLeft') + .wait(50) + .trigger('mouseup', { force: true, view: win }) + .then(() => { + const styleAfterDrag = Cypress.$('.react-flow__viewport').css('transform'); + expect(styleBeforeDrag).to.not.equal(styleAfterDrag); + }); + }); + }); - // it('drags the pane', () => { - // const styleBeforeDrag = Cypress.$('.react-flow__viewport').css('transform'); + it('zooms the pane', () => { + const styleBeforeZoom = Cypress.$('.react-flow__viewport').css('transform'); - // // for d3 we have to pass the window to the event - // // https://github.com/cypress-io/cypress/issues/3441 - // cy.window().then((win) => { - // cy.get('.react-flow__pane') - // .trigger('mousedown', 'topLeft', { button: 0, view: win }) - // .trigger('mousemove', 'bottomLeft') - // .wait(50) - // .trigger('mouseup', { force: true, view: win }) - // .then(() => { - // const styleAfterDrag = Cypress.$('.react-flow__viewport').css('transform'); - // expect(styleBeforeDrag).to.not.equal(styleAfterDrag); - // }); - // }); - // }); - - // it('zooms the pane', () => { - // const styleBeforeZoom = Cypress.$('.react-flow__viewport').css('transform'); - - // cy.get('.react-flow__pane') - // .trigger('wheel', 'topLeft', { deltaY: -200 }) - // .wait(50) - // .then(() => { - // const styleAfterZoom = Cypress.$('.react-flow__viewport').css('transform'); - // expect(styleBeforeZoom).to.not.equal(styleAfterZoom); - // }); - // }); + cy.get('.react-flow__pane') + .trigger('wheel', 'topLeft', { deltaY: -200 }) + .wait(50) + .then(() => { + const styleAfterZoom = Cypress.$('.react-flow__viewport').css('transform'); + expect(styleBeforeZoom).to.not.equal(styleAfterZoom); + }); + }); }); export {}; From 42309fbf0b10f6f1e5322fa003b1016efcb2e201 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Wed, 28 Sep 2022 11:24:32 +0100 Subject: [PATCH 23/35] tests: fix interaction test. --- examples/vite-app/cypress/e2e/interaction.cy.ts | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/examples/vite-app/cypress/e2e/interaction.cy.ts b/examples/vite-app/cypress/e2e/interaction.cy.ts index edfe6f11..1ad4bf2a 100644 --- a/examples/vite-app/cypress/e2e/interaction.cy.ts +++ b/examples/vite-app/cypress/e2e/interaction.cy.ts @@ -35,7 +35,18 @@ describe('Interaction Flow Rendering', () => { }); it('tries to do a selection', () => { - cy.get('body').type('{shift}', { release: false }).get('.react-flow__pane').should('not.exist'); + cy.get('body') + .type('{shift}', { release: false }) + .wait(50) + .get('.react-flow__pane') + .trigger('mousedown', 1000, 50, { button: 0, force: true }) + .trigger('mousemove', 1, 400, { button: 0 }) + .wait(50) + .get('.react-flow__selection') + .should('not.exist'); + + cy.get('.react-flow__pane').trigger('mouseup', 1, 200, { force: true }); + cy.get('body').type('{shift}', { release: true }); }); From 27a746bf57a4483208c4a2ad69b8c7506554f524 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Wed, 28 Sep 2022 11:31:39 +0100 Subject: [PATCH 24/35] tests: fix minimap test. --- examples/vite-app/cypress/e2e/minimap.cy.ts | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/examples/vite-app/cypress/e2e/minimap.cy.ts b/examples/vite-app/cypress/e2e/minimap.cy.ts index e6f4e3eb..bda3639a 100644 --- a/examples/vite-app/cypress/e2e/minimap.cy.ts +++ b/examples/vite-app/cypress/e2e/minimap.cy.ts @@ -9,13 +9,12 @@ describe('Minimap Testing', () => { }); it('has same number of nodes as the pane', () => { - const paneNodes = Cypress.$('.react-flow__node').length; + cy.get('.react-flow__minimap-node').then(() => { + const paneNodes = Cypress.$('.react-flow__node').length; + const minimapNodes = Cypress.$('.react-flow__minimap-node').length; - cy.wait(200); - - const minimapNodes = Cypress.$('.react-flow__minimap-node').length; - - expect(paneNodes).equal(minimapNodes); + expect(paneNodes).equal(minimapNodes); + }); }); it('changes zoom level', () => { From 6fe85b2cbec7305215df467cfcf57e9c2888bb72 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Wed, 28 Sep 2022 14:21:59 +0100 Subject: [PATCH 25/35] bug fix: handle all mouse move events not just ones on the target. --- packages/core/src/components/UserSelection/index.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index 44deca7c..781ca37d 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -96,7 +96,7 @@ const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, }; const onMouseMove = (event: React.MouseEvent): void => { - if (!isSelectionMode || !containerBounds.current || !userSelectionRect || event.target !== container.current) { + if (!isSelectionMode || !containerBounds.current || !userSelectionRect) { return; } From 4e874b90a8d9a1dc948871402dfff56e1dd6f00f Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Wed, 28 Sep 2022 14:44:54 +0100 Subject: [PATCH 26/35] feat: select overlapping nodes, even if not fully within box. --- packages/core/src/components/UserSelection/index.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index 781ca37d..8e691175 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -117,7 +117,7 @@ const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, const { nodeInternals, edges, transform, onNodesChange, onEdgesChange, nodeOrigin } = store.getState(); const nodes = Array.from(nodeInternals.values()); - const selectedNodes = getNodesInside(nodeInternals, nextUserSelectRect, transform, false, true, nodeOrigin); + const selectedNodes = getNodesInside(nodeInternals, nextUserSelectRect, transform, true, true, nodeOrigin); const selectedEdgeIds = getConnectedEdges(selectedNodes, edges).map((e) => e.id); const selectedNodeIds = selectedNodes.map((n) => n.id); From 1de6de1f96f9186080177413b6fcd6ca58d4b2de Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Wed, 28 Sep 2022 15:01:16 +0100 Subject: [PATCH 27/35] feat: add events for when selection starts and ends. --- .../src/components/UserSelection/index.tsx | 263 ++++++++++-------- .../core/src/container/FlowRenderer/index.tsx | 4 + .../core/src/container/ReactFlow/index.tsx | 4 + packages/core/src/types/component-props.ts | 2 + 4 files changed, 150 insertions(+), 123 deletions(-) diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index 8e691175..693ba368 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -19,6 +19,8 @@ type EventHandlers = { [key: string]: React.MouseEventHandler | React.WheelEvent type UserSelectionProps = { isSelectionMode: boolean; + onSelectionStart?: (e: React.MouseEvent) => void; + onSelectionEnd?: (e: React.MouseEvent) => void; onClick?: (e: React.MouseEvent) => void; onContextMenu?: (e: React.MouseEvent) => void; onWheel?: (e: React.WheelEvent) => void; @@ -55,144 +57,159 @@ const selector = (s: ReactFlowState) => ({ elementsSelectable: s.elementsSelectable, }); -const UserSelection = memo(({ isSelectionMode, onClick, onContextMenu, onWheel, children }: UserSelectionProps) => { - const container = useRef(null); - const store = useStoreApi(); - const prevSelectedNodesCount = useRef(0); - const prevSelectedEdgesCount = useRef(0); - const containerBounds = useRef(); - const [userSelectionRect, setUserSelectionRect] = useState(null); - const { userSelectionActive, elementsSelectable } = useStore(selector, shallow); +const UserSelection = memo( + ({ + isSelectionMode, + onSelectionStart, + onSelectionEnd, + onClick, + onContextMenu, + onWheel, + children, + }: UserSelectionProps) => { + const container = useRef(null); + const store = useStoreApi(); + const prevSelectedNodesCount = useRef(0); + const prevSelectedEdgesCount = useRef(0); + const containerBounds = useRef(); + const [userSelectionRect, setUserSelectionRect] = useState(null); + const { userSelectionActive, elementsSelectable } = useStore(selector, shallow); - const resetUserSelection = () => { - setUserSelectionRect(null); + const resetUserSelection = () => { + setUserSelectionRect(null); - store.setState({ userSelectionActive: false }); + store.setState({ userSelectionActive: false }); - prevSelectedNodesCount.current = 0; - prevSelectedEdgesCount.current = 0; - }; - - const onMouseDown = (event: React.MouseEvent): void => { - if (!elementsSelectable || !isSelectionMode || event.button !== 0 || event.target !== container.current) { - return; - } - - store.getState().resetSelectedElements(); - - const reactFlowNode = (event.target as Element).closest('.react-flow')!; - containerBounds.current = reactFlowNode.getBoundingClientRect(); - - const mousePos = getMousePosition(event, containerBounds.current!); - - setUserSelectionRect({ - width: 0, - height: 0, - startX: mousePos.x, - startY: mousePos.y, - x: mousePos.x, - y: mousePos.y, - }); - }; - - const onMouseMove = (event: React.MouseEvent): void => { - if (!isSelectionMode || !containerBounds.current || !userSelectionRect) { - return; - } - - store.setState({ userSelectionActive: true, nodesSelectionActive: false }); - - const mousePos = getMousePosition(event, containerBounds.current!); - const startX = userSelectionRect.startX ?? 0; - const startY = userSelectionRect.startY ?? 0; - - const nextUserSelectRect = { - ...userSelectionRect, - x: mousePos.x < startX ? mousePos.x : startX, - y: mousePos.y < startY ? mousePos.y : startY, - width: Math.abs(mousePos.x - startX), - height: Math.abs(mousePos.y - startY), - draw: true, + prevSelectedNodesCount.current = 0; + prevSelectedEdgesCount.current = 0; }; - const { nodeInternals, edges, transform, onNodesChange, onEdgesChange, nodeOrigin } = store.getState(); - const nodes = Array.from(nodeInternals.values()); - const selectedNodes = getNodesInside(nodeInternals, nextUserSelectRect, transform, true, true, nodeOrigin); - const selectedEdgeIds = getConnectedEdges(selectedNodes, edges).map((e) => e.id); - const selectedNodeIds = selectedNodes.map((n) => n.id); - - if (prevSelectedNodesCount.current !== selectedNodeIds.length) { - prevSelectedNodesCount.current = selectedNodeIds.length; - const changes = getSelectionChanges(nodes, selectedNodeIds) as NodeChange[]; - if (changes.length) { - onNodesChange?.(changes); + const onMouseDown = (event: React.MouseEvent): void => { + if (!elementsSelectable || !isSelectionMode || event.button !== 0 || event.target !== container.current) { + return; } - } - if (prevSelectedEdgesCount.current !== selectedEdgeIds.length) { - prevSelectedEdgesCount.current = selectedEdgeIds.length; - const changes = getSelectionChanges(edges, selectedEdgeIds) as EdgeChange[]; - if (changes.length) { - onEdgesChange?.(changes); + store.getState().resetSelectedElements(); + + const reactFlowNode = (event.target as Element).closest('.react-flow')!; + containerBounds.current = reactFlowNode.getBoundingClientRect(); + + const mousePos = getMousePosition(event, containerBounds.current!); + + setUserSelectionRect({ + width: 0, + height: 0, + startX: mousePos.x, + startY: mousePos.y, + x: mousePos.x, + y: mousePos.y, + }); + + onSelectionStart?.(event); + }; + + const onMouseMove = (event: React.MouseEvent): void => { + if (!isSelectionMode || !containerBounds.current || !userSelectionRect) { + return; } - } - setUserSelectionRect(nextUserSelectRect); - }; + store.setState({ userSelectionActive: true, nodesSelectionActive: false }); - const onMouseUp = (event: React.MouseEvent) => { - // We only want to trigger click functions when in selection mode if - // the user did not move the mouse. - if (!userSelectionActive && userSelectionRect && event.target === container.current) { - onClick?.(event); - } + const mousePos = getMousePosition(event, containerBounds.current!); + const startX = userSelectionRect.startX ?? 0; + const startY = userSelectionRect.startY ?? 0; - store.setState({ nodesSelectionActive: prevSelectedNodesCount.current > 0 }); + const nextUserSelectRect = { + ...userSelectionRect, + x: mousePos.x < startX ? mousePos.x : startX, + y: mousePos.y < startY ? mousePos.y : startY, + width: Math.abs(mousePos.x - startX), + height: Math.abs(mousePos.y - startY), + draw: true, + }; - resetUserSelection(); - }; + const { nodeInternals, edges, transform, onNodesChange, onEdgesChange, nodeOrigin } = store.getState(); + const nodes = Array.from(nodeInternals.values()); + const selectedNodes = getNodesInside(nodeInternals, nextUserSelectRect, transform, true, true, nodeOrigin); + const selectedEdgeIds = getConnectedEdges(selectedNodes, edges).map((e) => e.id); + const selectedNodeIds = selectedNodes.map((n) => n.id); - const onMouseLeave = () => { - if (userSelectionActive) { - store.setState({ nodesSelectionActive: prevSelectedNodesCount.current > 0 }); - } - resetUserSelection(); - }; - - const eventHandlers = - elementsSelectable && (isSelectionMode || userSelectionActive) - ? { - ...wrapHandlers({ onContextMenu, onWheel }, container), - onMouseDown, - onMouseMove, - onMouseUp, - onMouseLeave, + if (prevSelectedNodesCount.current !== selectedNodeIds.length) { + prevSelectedNodesCount.current = selectedNodeIds.length; + const changes = getSelectionChanges(nodes, selectedNodeIds) as NodeChange[]; + if (changes.length) { + onNodesChange?.(changes); } - : wrapHandlers( - { - onClick, - onContextMenu, - onWheel, - }, - container - ); + } - return ( -
- {children} - {userSelectionActive && userSelectionRect && ( -
- )} -
- ); -}); + if (prevSelectedEdgesCount.current !== selectedEdgeIds.length) { + prevSelectedEdgesCount.current = selectedEdgeIds.length; + const changes = getSelectionChanges(edges, selectedEdgeIds) as EdgeChange[]; + if (changes.length) { + onEdgesChange?.(changes); + } + } + + setUserSelectionRect(nextUserSelectRect); + }; + + const onMouseUp = (event: React.MouseEvent) => { + // We only want to trigger click functions when in selection mode if + // the user did not move the mouse. + if (!userSelectionActive && userSelectionRect && event.target === container.current) { + onClick?.(event); + } + + store.setState({ nodesSelectionActive: prevSelectedNodesCount.current > 0 }); + + resetUserSelection(); + + onSelectionEnd?.(event); + }; + + const onMouseLeave = (event: React.MouseEvent) => { + if (userSelectionActive) { + store.setState({ nodesSelectionActive: prevSelectedNodesCount.current > 0 }); + onSelectionEnd?.(event); + } + resetUserSelection(); + }; + + const eventHandlers = + elementsSelectable && (isSelectionMode || userSelectionActive) + ? { + ...wrapHandlers({ onContextMenu, onWheel }, container), + onMouseDown, + onMouseMove, + onMouseUp, + onMouseLeave, + } + : wrapHandlers( + { + onClick, + onContextMenu, + onWheel, + }, + container + ); + + return ( +
+ {children} + {userSelectionActive && userSelectionRect && ( +
+ )} +
+ ); + } +); UserSelection.displayName = 'UserSelection'; diff --git a/packages/core/src/container/FlowRenderer/index.tsx b/packages/core/src/container/FlowRenderer/index.tsx index d203033b..a5853a09 100644 --- a/packages/core/src/container/FlowRenderer/index.tsx +++ b/packages/core/src/container/FlowRenderer/index.tsx @@ -45,6 +45,8 @@ const FlowRenderer = ({ onMoveEnd, selectionKeyCode, selectBoxOnDrag, + onSelectionStart, + onSelectionEnd, multiSelectionKeyCode, zoomActivationKeyCode, elementsSelectable, @@ -112,6 +114,8 @@ const FlowRenderer = ({ noPanClassName={noPanClassName} > ( onSelectionDrag, onSelectionDragStop, onSelectionContextMenu, + onSelectionStart, + onSelectionEnd, connectionMode = ConnectionMode.Strict, connectionLineType = ConnectionLineType.Bezier, connectionLineStyle, @@ -219,6 +221,8 @@ const ReactFlow = forwardRef( onPaneScroll={onPaneScroll} onPaneContextMenu={onPaneContextMenu} onSelectionContextMenu={onSelectionContextMenu} + onSelectionStart={onSelectionStart} + onSelectionEnd={onSelectionEnd} onEdgeUpdate={onEdgeUpdate} onEdgeContextMenu={onEdgeContextMenu} onEdgeDoubleClick={onEdgeDoubleClick} diff --git a/packages/core/src/types/component-props.ts b/packages/core/src/types/component-props.ts index 9cf390a7..27498ba0 100644 --- a/packages/core/src/types/component-props.ts +++ b/packages/core/src/types/component-props.ts @@ -68,6 +68,8 @@ export type ReactFlowProps = HTMLAttributes & { onSelectionDragStart?: SelectionDragHandler; onSelectionDrag?: SelectionDragHandler; onSelectionDragStop?: SelectionDragHandler; + onSelectionStart?: (event: ReactMouseEvent) => void; + onSelectionEnd?: (event: ReactMouseEvent) => void; onSelectionContextMenu?: (event: ReactMouseEvent, nodes: Node[]) => void; onConnect?: OnConnect; onConnectStart?: OnConnectStart; From f25c7fe8a231ac741ebaf999e7e34d08852759d6 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Wed, 28 Sep 2022 15:07:24 +0100 Subject: [PATCH 28/35] feat: pass through onSelectionStart in GraphView. --- packages/core/src/container/GraphView/index.tsx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/core/src/container/GraphView/index.tsx b/packages/core/src/container/GraphView/index.tsx index 4017810d..54733d12 100644 --- a/packages/core/src/container/GraphView/index.tsx +++ b/packages/core/src/container/GraphView/index.tsx @@ -51,6 +51,8 @@ const GraphView = ({ onNodeMouseLeave, onNodeContextMenu, onSelectionContextMenu, + onSelectionStart, + onSelectionEnd, connectionLineType, connectionLineStyle, connectionLineComponent, @@ -112,6 +114,8 @@ const GraphView = ({ deleteKeyCode={deleteKeyCode} selectionKeyCode={selectionKeyCode} selectBoxOnDrag={selectBoxOnDrag} + onSelectionStart={onSelectionStart} + onSelectionEnd={onSelectionEnd} multiSelectionKeyCode={multiSelectionKeyCode} zoomActivationKeyCode={zoomActivationKeyCode} elementsSelectable={elementsSelectable} From 09ebd0c84a9521819b4a45501226bb61b638449c Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Wed, 28 Sep 2022 16:20:57 +0100 Subject: [PATCH 29/35] feat: allow customisation of how the select box works. --- .../core/src/components/UserSelection/index.tsx | 13 +++++++++++-- packages/core/src/container/FlowRenderer/index.tsx | 2 ++ packages/core/src/container/GraphView/index.tsx | 2 ++ packages/core/src/container/ReactFlow/index.tsx | 2 ++ packages/core/src/types/component-props.ts | 1 + 5 files changed, 18 insertions(+), 2 deletions(-) diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index 693ba368..fa2fdc4f 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -8,7 +8,7 @@ import shallow from 'zustand/shallow'; import { useStore, useStoreApi } from '../../hooks/useStore'; import { getSelectionChanges } from '../../utils/changes'; import { getConnectedEdges, getNodesInside } from '../../utils/graph'; -import type { XYPosition, ReactFlowState, NodeChange, EdgeChange, Rect } from '../../types'; +import type { XYPosition, ReactFlowState, NodeChange, EdgeChange, Rect, ReactFlowProps } from '../../types'; type SelectionRect = Rect & { startX: number; @@ -19,6 +19,7 @@ type EventHandlers = { [key: string]: React.MouseEventHandler | React.WheelEvent type UserSelectionProps = { isSelectionMode: boolean; + selectBoxMode?: ReactFlowProps['selectBoxMode']; onSelectionStart?: (e: React.MouseEvent) => void; onSelectionEnd?: (e: React.MouseEvent) => void; onClick?: (e: React.MouseEvent) => void; @@ -60,6 +61,7 @@ const selector = (s: ReactFlowState) => ({ const UserSelection = memo( ({ isSelectionMode, + selectBoxMode = 'Contained', onSelectionStart, onSelectionEnd, onClick, @@ -130,7 +132,14 @@ const UserSelection = memo( const { nodeInternals, edges, transform, onNodesChange, onEdgesChange, nodeOrigin } = store.getState(); const nodes = Array.from(nodeInternals.values()); - const selectedNodes = getNodesInside(nodeInternals, nextUserSelectRect, transform, true, true, nodeOrigin); + const selectedNodes = getNodesInside( + nodeInternals, + nextUserSelectRect, + transform, + selectBoxMode === 'Overlap', + true, + nodeOrigin + ); const selectedEdgeIds = getConnectedEdges(selectedNodes, edges).map((e) => e.id); const selectedNodeIds = selectedNodes.map((n) => n.id); diff --git a/packages/core/src/container/FlowRenderer/index.tsx b/packages/core/src/container/FlowRenderer/index.tsx index a5853a09..de1f3dd5 100644 --- a/packages/core/src/container/FlowRenderer/index.tsx +++ b/packages/core/src/container/FlowRenderer/index.tsx @@ -45,6 +45,7 @@ const FlowRenderer = ({ onMoveEnd, selectionKeyCode, selectBoxOnDrag, + selectBoxMode, onSelectionStart, onSelectionEnd, multiSelectionKeyCode, @@ -123,6 +124,7 @@ const FlowRenderer = ({ onContextMenu={onContextMenu} onWheel={onWheel} isSelectionMode={isSelectionMode} + selectBoxMode={selectBoxMode} > {children} {nodesSelectionActive && ( diff --git a/packages/core/src/container/GraphView/index.tsx b/packages/core/src/container/GraphView/index.tsx index 54733d12..a0cedc43 100644 --- a/packages/core/src/container/GraphView/index.tsx +++ b/packages/core/src/container/GraphView/index.tsx @@ -59,6 +59,7 @@ const GraphView = ({ connectionLineContainerStyle, selectionKeyCode, selectBoxOnDrag, + selectBoxMode, multiSelectionKeyCode, zoomActivationKeyCode, deleteKeyCode, @@ -114,6 +115,7 @@ const GraphView = ({ deleteKeyCode={deleteKeyCode} selectionKeyCode={selectionKeyCode} selectBoxOnDrag={selectBoxOnDrag} + selectBoxMode={selectBoxMode} onSelectionStart={onSelectionStart} onSelectionEnd={onSelectionEnd} multiSelectionKeyCode={multiSelectionKeyCode} diff --git a/packages/core/src/container/ReactFlow/index.tsx b/packages/core/src/container/ReactFlow/index.tsx index ca9aefbb..46e6971c 100644 --- a/packages/core/src/container/ReactFlow/index.tsx +++ b/packages/core/src/container/ReactFlow/index.tsx @@ -102,6 +102,7 @@ const ReactFlow = forwardRef( deleteKeyCode = 'Backspace', selectionKeyCode = 'Shift', selectBoxOnDrag = false, + selectBoxMode = 'Contained', multiSelectionKeyCode = 'Meta', zoomActivationKeyCode = 'Meta', snapToGrid = false, @@ -197,6 +198,7 @@ const ReactFlow = forwardRef( connectionLineContainerStyle={connectionLineContainerStyle} selectionKeyCode={selectionKeyCode} selectBoxOnDrag={selectBoxOnDrag} + selectBoxMode={selectBoxMode} deleteKeyCode={deleteKeyCode} multiSelectionKeyCode={multiSelectionKeyCode} zoomActivationKeyCode={zoomActivationKeyCode} diff --git a/packages/core/src/types/component-props.ts b/packages/core/src/types/component-props.ts index 27498ba0..a96f006e 100644 --- a/packages/core/src/types/component-props.ts +++ b/packages/core/src/types/component-props.ts @@ -97,6 +97,7 @@ export type ReactFlowProps = HTMLAttributes & { deleteKeyCode?: KeyCode | null; selectionKeyCode?: KeyCode | null; selectBoxOnDrag?: boolean; + selectBoxMode?: 'Overlap' | 'Contained'; multiSelectionKeyCode?: KeyCode | null; zoomActivationKeyCode?: KeyCode | null; snapToGrid?: boolean; From 5a192e0068dcec70e2f2da7a769a410c2ecf0ddd Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Wed, 28 Sep 2022 16:21:34 +0100 Subject: [PATCH 30/35] chore: add select box mode to figma example. --- examples/vite-app/src/examples/Figma/index.tsx | 1 + 1 file changed, 1 insertion(+) diff --git a/examples/vite-app/src/examples/Figma/index.tsx b/examples/vite-app/src/examples/Figma/index.tsx index e1365ec4..59d887ad 100644 --- a/examples/vite-app/src/examples/Figma/index.tsx +++ b/examples/vite-app/src/examples/Figma/index.tsx @@ -61,6 +61,7 @@ const BasicFlow = () => { defaultNodes={initialNodes} defaultEdges={initialEdges} selectBoxOnDrag + selectBoxMode="Overlap" panOnDrag={spaceBarPressed ? true : 'RightClick'} panOnScroll onPaneContextMenu={logEvent} From 35bc158adebd13eea2745ef0d33d3ba58953a2c8 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Wed, 28 Sep 2022 17:06:28 +0100 Subject: [PATCH 31/35] bug fix: fixes post rebase. --- examples/vite-app/src/examples/Figma/index.tsx | 2 +- packages/core/src/components/UserSelection/index.tsx | 9 +++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/examples/vite-app/src/examples/Figma/index.tsx b/examples/vite-app/src/examples/Figma/index.tsx index 59d887ad..12b867fe 100644 --- a/examples/vite-app/src/examples/Figma/index.tsx +++ b/examples/vite-app/src/examples/Figma/index.tsx @@ -6,7 +6,7 @@ import ReactFlow, { Edge, useReactFlow, useKeyPress, -} from 'react-flow-renderer'; +} from 'reactflow'; const MULTI_SELECT_KEY = ['Meta', 'Shift']; diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index fa2fdc4f..bfd8adda 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -25,6 +25,9 @@ type UserSelectionProps = { onClick?: (e: React.MouseEvent) => void; onContextMenu?: (e: React.MouseEvent) => void; onWheel?: (e: React.WheelEvent) => void; + onMouseEnter?: (e: React.MouseEvent) => void; + onMouseMove?: (e: React.MouseEvent) => void; + onMouseLeave?: (e: React.MouseEvent) => void; children: React.ReactNode; }; @@ -67,6 +70,9 @@ const UserSelection = memo( onClick, onContextMenu, onWheel, + onMouseEnter: onPaneMouseEnter, + onMouseMove: onPaneMouseMove, + onMouseLeave: onPaneMouseLeave, children, }: UserSelectionProps) => { const container = useRef(null); @@ -198,6 +204,9 @@ const UserSelection = memo( onClick, onContextMenu, onWheel, + onMouseEnter: onPaneMouseEnter, + onMouseMove: onPaneMouseMove, + onMouseLeave: onPaneMouseLeave, }, container ); From 64c84917615442a5a11741c706d881b1cdb03c65 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Wed, 28 Sep 2022 17:14:13 +0100 Subject: [PATCH 32/35] bug fix: more post rebase fixes. --- .../src/components/UserSelection/index.tsx | 12 +++++-- .../core/src/container/FlowRenderer/Pane.tsx | 34 ------------------- .../core/src/container/FlowRenderer/index.tsx | 1 - 3 files changed, 10 insertions(+), 37 deletions(-) delete mode 100644 packages/core/src/container/FlowRenderer/Pane.tsx diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index bfd8adda..b16c7299 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -4,7 +4,9 @@ import { memo, useState, useRef } from 'react'; import shallow from 'zustand/shallow'; +import cc from 'classcat'; +import { containerStyle } from '../../styles'; import { useStore, useStoreApi } from '../../hooks/useStore'; import { getSelectionChanges } from '../../utils/changes'; import { getConnectedEdges, getNodesInside } from '../../utils/graph'; @@ -59,6 +61,7 @@ const wrapHandlers = ( const selector = (s: ReactFlowState) => ({ userSelectionActive: s.userSelectionActive, elementsSelectable: s.elementsSelectable, + paneDragging: s.paneDragging, }); const UserSelection = memo( @@ -81,7 +84,7 @@ const UserSelection = memo( const prevSelectedEdgesCount = useRef(0); const containerBounds = useRef(); const [userSelectionRect, setUserSelectionRect] = useState(null); - const { userSelectionActive, elementsSelectable } = useStore(selector, shallow); + const { userSelectionActive, elementsSelectable, paneDragging } = useStore(selector, shallow); const resetUserSelection = () => { setUserSelectionRect(null); @@ -212,7 +215,12 @@ const UserSelection = memo( ); return ( -
+
{children} {userSelectionActive && userSelectionRect && (
& { - onMouseEnter?: (event: MouseEvent) => void; - onMouseMove?: (event: MouseEvent) => void; - onMouseLeave?: (event: MouseEvent) => void; -}; - -const selector = (s: ReactFlowState) => s.paneDragging; - -function Pane({ onClick, onMouseEnter, onMouseMove, onMouseLeave, onContextMenu, onWheel }: PaneProps) { - const dragging = useStore(selector); - - return ( -
- ); -} - -export default Pane; diff --git a/packages/core/src/container/FlowRenderer/index.tsx b/packages/core/src/container/FlowRenderer/index.tsx index de1f3dd5..84abdb23 100644 --- a/packages/core/src/container/FlowRenderer/index.tsx +++ b/packages/core/src/container/FlowRenderer/index.tsx @@ -8,7 +8,6 @@ import { GraphViewProps } from '../GraphView'; import ZoomPane from '../ZoomPane'; import UserSelection from '../../components/UserSelection'; import NodesSelection from '../../components/NodesSelection'; -import Pane from './Pane'; import type { ReactFlowState } from '../../types'; export type FlowRendererProps = Omit< From a8e414e4a2d37e7556b398650a6fec0def0be067 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Wed, 28 Sep 2022 17:23:36 +0100 Subject: [PATCH 33/35] feat: display the pointer when in selection mode. --- packages/core/src/components/UserSelection/index.tsx | 7 +++++-- packages/core/src/styles/init.css | 4 ++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/packages/core/src/components/UserSelection/index.tsx b/packages/core/src/components/UserSelection/index.tsx index b16c7299..38d5a5ba 100644 --- a/packages/core/src/components/UserSelection/index.tsx +++ b/packages/core/src/components/UserSelection/index.tsx @@ -136,7 +136,6 @@ const UserSelection = memo( y: mousePos.y < startY ? mousePos.y : startY, width: Math.abs(mousePos.x - startX), height: Math.abs(mousePos.y - startY), - draw: true, }; const { nodeInternals, edges, transform, onNodesChange, onEdgesChange, nodeOrigin } = store.getState(); @@ -216,7 +215,11 @@ const UserSelection = memo( return (
Date: Sat, 22 Oct 2022 09:49:33 +0100 Subject: [PATCH 34/35] tests: add tests for the new features. --- examples/vite-app/cypress/e2e/figma.cy.ts | 52 +++++++++++++++++++ examples/vite-app/cypress/support/commands.ts | 22 ++++---- 2 files changed, 64 insertions(+), 10 deletions(-) create mode 100644 examples/vite-app/cypress/e2e/figma.cy.ts diff --git a/examples/vite-app/cypress/e2e/figma.cy.ts b/examples/vite-app/cypress/e2e/figma.cy.ts new file mode 100644 index 00000000..6d3ddfea --- /dev/null +++ b/examples/vite-app/cypress/e2e/figma.cy.ts @@ -0,0 +1,52 @@ +describe('Figma Flow UI', () => { + before(() => { + cy.visit('/figma'); + }); + + it('renders a flow with three nodes', () => { + cy.get('.react-flow__renderer'); + cy.get('.react-flow-basic-example'); // check if className prop works + cy.get('.react-flow__node').should('have.length', 4); + cy.get('.react-flow__edge').should('have.length', 2); + cy.get('.react-flow__node').children('.react-flow__handle'); + }); + + it('renders a grid', () => { + cy.get('.react-flow__background'); + }); + + it('selects all nodes by drag', () => { + cy.window().then((win) => { + cy.get('.react-flow__pane') + .trigger('mousedown', 'topLeft', { button: 0, view: win }) + .trigger('mousemove', 'bottomRight', { force: true }) + .wait(50) + .trigger('mouseup', { force: true, view: win }) + .then(() => { + cy.get('.react-flow__node').should('have.class', 'selected'); + }); + }); + }); + + it('removes selection', () => { + cy.get('.react-flow__pane').click('topLeft'); + cy.get('.react-flow__node').should('not.have.class', 'selected'); + }); + + it('drags using right click', () => { + cy.window().then((win) => { + cy.get('.react-flow__node:last').isWithinViewport(); + cy.get('.react-flow__pane') + .trigger('mousedown', 'center', { button: 2, view: win }) + .trigger('mousemove', 'bottom', { force: true }) + .wait(50) + .trigger('mouseup', { force: true, view: win }) + .then(() => { + cy.get('.react-flow__node').should('not.have.class', 'selected'); + cy.get('.react-flow__node:last').isOutsideViewport(); + }); + }); + }); +}); + +export {}; diff --git a/examples/vite-app/cypress/support/commands.ts b/examples/vite-app/cypress/support/commands.ts index 14302409..e138e4cf 100644 --- a/examples/vite-app/cypress/support/commands.ts +++ b/examples/vite-app/cypress/support/commands.ts @@ -36,23 +36,25 @@ Cypress.Commands.add('zoomPane', (wheelDelta: number) => Cypress.Commands.add('isWithinViewport', { prevSubject: true }, (subject) => { const rect = subject[0].getBoundingClientRect(); - expect(rect.top).to.be.within(0, window.innerHeight); - expect(rect.right).to.be.within(0, window.innerWidth); - expect(rect.bottom).to.be.within(0, window.innerHeight); - expect(rect.left).to.be.within(0, window.innerWidth); + return cy.window().then((window) => { + expect(rect.top).to.be.within(0, window.innerHeight); + expect(rect.right).to.be.within(0, window.innerWidth); + expect(rect.bottom).to.be.within(0, window.innerHeight); + expect(rect.left).to.be.within(0, window.innerWidth); - return subject; + return subject; + }); }); Cypress.Commands.add('isOutsideViewport', { prevSubject: true }, (subject) => { const rect = subject[0].getBoundingClientRect(); - expect(rect.top).not.to.be.within(0, window.innerHeight); - expect(rect.right).not.to.be.within(0, window.innerWidth); - expect(rect.bottom).not.to.be.within(0, window.innerHeight); - expect(rect.left).not.to.be.within(0, window.innerWidth); + return cy.window().then((window) => { + expect(window.innerHeight < rect.top || rect.bottom < 0 || window.innerWidth < rect.left || rect.right < 0).to.be + .true; - return subject; + return subject; + }); }); export {}; From 2f767408ca08ac047f3780e02f6b1ed4caf203f5 Mon Sep 17 00:00:00 2001 From: Jack Fishwick Date: Thu, 17 Nov 2022 13:39:38 +0000 Subject: [PATCH 35/35] chore: fix typing on 'isSelectionMode'. --- packages/core/src/container/FlowRenderer/index.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/src/container/FlowRenderer/index.tsx b/packages/core/src/container/FlowRenderer/index.tsx index 84abdb23..bd31f0d1 100644 --- a/packages/core/src/container/FlowRenderer/index.tsx +++ b/packages/core/src/container/FlowRenderer/index.tsx @@ -122,7 +122,7 @@ const FlowRenderer = ({ onMouseLeave={onPaneMouseLeave} onContextMenu={onContextMenu} onWheel={onWheel} - isSelectionMode={isSelectionMode} + isSelectionMode={!!isSelectionMode} selectBoxMode={selectBoxMode} > {children}