@octanejs/xyflow 0.1.18 → 0.1.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/package.json +6 -6
  2. package/src/additional-components/Background/Background.tsrx +32 -26
  3. package/src/additional-components/Background/Patterns.tsrx +15 -11
  4. package/src/additional-components/Controls/ControlButton.tsrx +5 -5
  5. package/src/additional-components/Controls/Controls.tsrx +48 -44
  6. package/src/additional-components/Controls/Icons/FitView.tsrx +5 -5
  7. package/src/additional-components/Controls/Icons/Lock.tsrx +5 -5
  8. package/src/additional-components/Controls/Icons/Minus.tsrx +5 -3
  9. package/src/additional-components/Controls/Icons/Plus.tsrx +5 -3
  10. package/src/additional-components/Controls/Icons/Unlock.tsrx +5 -5
  11. package/src/additional-components/EdgeToolbar/EdgeToolbar.tsrx +20 -17
  12. package/src/additional-components/MiniMap/MiniMap.tsrx +85 -86
  13. package/src/additional-components/MiniMap/MiniMapNode.tsrx +18 -16
  14. package/src/additional-components/MiniMap/MiniMapNodes.tsrx +47 -45
  15. package/src/additional-components/NodeResizer/NodeResizeControl.tsrx +31 -30
  16. package/src/additional-components/NodeResizer/NodeResizer.tsrx +10 -10
  17. package/src/additional-components/NodeToolbar/NodeToolbar.tsrx +32 -25
  18. package/src/components/A11yDescriptions/index.tsrx +23 -18
  19. package/src/components/Attribution/index.tsrx +11 -9
  20. package/src/components/BatchProvider/index.tsrx +8 -11
  21. package/src/components/ConnectionLine/index.tsrx +31 -27
  22. package/src/components/EdgeWrapper/EdgeUpdateAnchors.tsrx +38 -35
  23. package/src/components/EdgeWrapper/index.tsrx +155 -146
  24. package/src/components/Edges/BaseEdge.tsrx +16 -14
  25. package/src/components/Edges/BezierEdge.tsrx +47 -43
  26. package/src/components/Edges/EdgeAnchor.tsrx +13 -11
  27. package/src/components/Edges/EdgeText.tsrx +31 -26
  28. package/src/components/Edges/SimpleBezierEdge.tsrx +55 -44
  29. package/src/components/Edges/SmoothStepEdge.tsrx +49 -45
  30. package/src/components/Edges/StepEdge.tsrx +10 -7
  31. package/src/components/Edges/StraightEdge.tsrx +40 -36
  32. package/src/components/Handle/index.tsrx +73 -63
  33. package/src/components/NodeWrapper/index.tsrx +86 -72
  34. package/src/components/Nodes/DefaultNode.tsrx +7 -5
  35. package/src/components/Nodes/InputNode.tsrx +11 -7
  36. package/src/components/Nodes/OutputNode.tsrx +11 -7
  37. package/src/components/NodesSelection/index.tsrx +23 -22
  38. package/src/components/Panel/index.tsrx +17 -14
  39. package/src/components/ReactFlowProvider/index.tsrx +25 -23
  40. package/src/components/SelectionListener/index.tsrx +4 -2
  41. package/src/components/StoreUpdater/index.tsrx +43 -34
  42. package/src/components/UserSelection/index.tsrx +10 -8
  43. package/src/container/EdgeRenderer/MarkerDefinitions.tsrx +34 -29
  44. package/src/container/EdgeRenderer/MarkerSymbols.tsrx +21 -17
  45. package/src/container/EdgeRenderer/index.tsrx +52 -49
  46. package/src/container/FlowRenderer/index.tsrx +67 -66
  47. package/src/container/GraphView/index.tsrx +98 -96
  48. package/src/container/NodeRenderer/index.tsrx +74 -71
  49. package/src/container/Pane/index.tsrx +69 -60
  50. package/src/container/ReactFlow/Wrapper.tsrx +23 -21
  51. package/src/container/ReactFlow/index.tsrx +158 -153
  52. package/src/container/Viewport/index.tsrx +13 -7
  53. package/src/container/ZoomPane/index.tsrx +28 -25
@@ -9,25 +9,24 @@ import { useResizeObserver } from './useResizeObserver';
9
9
  import NodeWrapper from '../../components/NodeWrapper/index.tsrx';
10
10
  import type { Node, ReactFlowState } from '../../types';
11
11
 
12
- export type NodeRendererProps<NodeType extends Node> =
13
- Pick<
14
- GraphViewProps<NodeType>,
15
- | 'onNodeClick'
16
- | 'onNodeDoubleClick'
17
- | 'onNodeMouseEnter'
18
- | 'onNodeMouseMove'
19
- | 'onNodeMouseLeave'
20
- | 'onNodeContextMenu'
21
- | 'onlyRenderVisibleElements'
22
- | 'noPanClassName'
23
- | 'noDragClassName'
24
- | 'rfId'
25
- | 'disableKeyboardA11y'
26
- | 'nodeExtent'
27
- | 'nodeTypes'
28
- | 'nodeClickDistance'
29
- | 'nodesDraggable'
30
- >;
12
+ export type NodeRendererProps<NodeType extends Node> = Pick<
13
+ GraphViewProps<NodeType>,
14
+ | 'onNodeClick'
15
+ | 'onNodeDoubleClick'
16
+ | 'onNodeMouseEnter'
17
+ | 'onNodeMouseMove'
18
+ | 'onNodeMouseLeave'
19
+ | 'onNodeContextMenu'
20
+ | 'onlyRenderVisibleElements'
21
+ | 'noPanClassName'
22
+ | 'noDragClassName'
23
+ | 'rfId'
24
+ | 'disableKeyboardA11y'
25
+ | 'nodeExtent'
26
+ | 'nodeTypes'
27
+ | 'nodeClickDistance'
28
+ | 'nodesDraggable'
29
+ >;
31
30
 
32
31
  const selector = (s: ReactFlowState) => ({
33
32
  nodesConnectable: s.nodesConnectable,
@@ -44,58 +43,62 @@ function NodeRendererComponent<NodeType extends Node>(props: NodeRendererProps<N
44
43
  const nodeIds = useVisibleNodeIds(props.onlyRenderVisibleElements);
45
44
  const resizeObserver = useResizeObserver();
46
45
 
47
- return <div className="react-flow__nodes" style={containerStyle}>{nodeIds.map((nodeId) => {
48
- return (
49
- /*
50
- * The split of responsibilities between NodeRenderer and
51
- * NodeComponentWrapper may appear weird. However, it’s designed to
52
- * minimize the cost of updates when individual nodes change.
53
- *
54
- * For example, when you’re dragging a single node, that node gets
55
- * updated multiple times per second. If `NodeRenderer` were to update
56
- * every time, it would have to re-run the `nodes.map()` loop every
57
- * time. This gets pricey with hundreds of nodes, especially if every
58
- * loop cycle does more than just rendering a JSX element!
59
- *
60
- * As a result of this choice, we took the following implementation
61
- * decisions:
62
- * - NodeRenderer subscribes *only* to node IDs – and therefore
63
- * rerender *only* when visible nodes are added or removed.
64
- * - NodeRenderer performs all operations the result of which can be
65
- * shared between nodes (such as creating the `ResizeObserver`
66
- * instance, or subscribing to `selector`). This means extra prop
67
- * drilling into `NodeComponentWrapper`, but it means we need to run
68
- * these operations only once – instead of once per node.
69
- * - Any operations that you’d normally write inside `nodes.map` are
70
- * moved into `NodeComponentWrapper`. This ensures they are
71
- * memorized – so if `NodeRenderer` *has* to rerender, it only
72
- * needs to regenerate the list of nodes, nothing else.
73
- */
74
- <NodeWrapper
75
- key={nodeId}
76
- id={nodeId}
77
- nodeTypes={props.nodeTypes}
78
- nodeExtent={props.nodeExtent}
79
- onClick={props.onNodeClick}
80
- onMouseEnter={props.onNodeMouseEnter}
81
- onMouseMove={props.onNodeMouseMove}
82
- onMouseLeave={props.onNodeMouseLeave}
83
- onContextMenu={props.onNodeContextMenu}
84
- onDoubleClick={props.onNodeDoubleClick}
85
- noDragClassName={props.noDragClassName}
86
- noPanClassName={props.noPanClassName}
87
- rfId={props.rfId}
88
- disableKeyboardA11y={props.disableKeyboardA11y}
89
- resizeObserver={resizeObserver}
90
- nodesDraggable={props.nodesDraggable ?? true}
91
- nodesConnectable={nodesConnectable}
92
- nodesFocusable={nodesFocusable}
93
- elementsSelectable={elementsSelectable}
94
- nodeClickDistance={props.nodeClickDistance}
95
- onError={onError}
96
- />
97
- );
98
- })}</div>;
46
+ return (
47
+ <div className="react-flow__nodes" style={containerStyle}>
48
+ {nodeIds.map((nodeId) => {
49
+ return (
50
+ /*
51
+ * The split of responsibilities between NodeRenderer and
52
+ * NodeComponentWrapper may appear weird. However, it’s designed to
53
+ * minimize the cost of updates when individual nodes change.
54
+ *
55
+ * For example, when you’re dragging a single node, that node gets
56
+ * updated multiple times per second. If `NodeRenderer` were to update
57
+ * every time, it would have to re-run the `nodes.map()` loop every
58
+ * time. This gets pricey with hundreds of nodes, especially if every
59
+ * loop cycle does more than just rendering a JSX element!
60
+ *
61
+ * As a result of this choice, we took the following implementation
62
+ * decisions:
63
+ * - NodeRenderer subscribes *only* to node IDs – and therefore
64
+ * rerender *only* when visible nodes are added or removed.
65
+ * - NodeRenderer performs all operations the result of which can be
66
+ * shared between nodes (such as creating the `ResizeObserver`
67
+ * instance, or subscribing to `selector`). This means extra prop
68
+ * drilling into `NodeComponentWrapper`, but it means we need to run
69
+ * these operations only once – instead of once per node.
70
+ * - Any operations that you’d normally write inside `nodes.map` are
71
+ * moved into `NodeComponentWrapper`. This ensures they are
72
+ * memorized – so if `NodeRenderer` *has* to rerender, it only
73
+ * needs to regenerate the list of nodes, nothing else.
74
+ */
75
+ <NodeWrapper
76
+ key={nodeId}
77
+ id={nodeId}
78
+ nodeTypes={props.nodeTypes}
79
+ nodeExtent={props.nodeExtent}
80
+ onClick={props.onNodeClick}
81
+ onMouseEnter={props.onNodeMouseEnter}
82
+ onMouseMove={props.onNodeMouseMove}
83
+ onMouseLeave={props.onNodeMouseLeave}
84
+ onContextMenu={props.onNodeContextMenu}
85
+ onDoubleClick={props.onNodeDoubleClick}
86
+ noDragClassName={props.noDragClassName}
87
+ noPanClassName={props.noPanClassName}
88
+ rfId={props.rfId}
89
+ disableKeyboardA11y={props.disableKeyboardA11y}
90
+ resizeObserver={resizeObserver}
91
+ nodesDraggable={props.nodesDraggable ?? true}
92
+ nodesConnectable={nodesConnectable}
93
+ nodesFocusable={nodesFocusable}
94
+ elementsSelectable={elementsSelectable}
95
+ nodeClickDistance={props.nodeClickDistance}
96
+ onError={onError}
97
+ />
98
+ );
99
+ })}
100
+ </div>
101
+ );
99
102
  }
100
103
 
101
104
  NodeRendererComponent.displayName = 'NodeRenderer';
@@ -25,31 +25,30 @@ import { useStore, useStoreApi } from '../../hooks/useStore';
25
25
  import { getSelectionChanges } from '../../utils';
26
26
  import type { ReactFlowProps, ReactFlowState } from '../../types';
27
27
 
28
- type PaneProps =
29
- {
30
- isSelecting: boolean;
31
- selectionKeyPressed: boolean;
32
- children: OctaneNode;
33
- paneClickDistance: number;
34
- } & Partial<
35
- Pick<
36
- ReactFlowProps,
37
- | 'selectionMode'
38
- | 'panOnDrag'
39
- | 'autoPanOnSelection'
40
- | 'onSelectionStart'
41
- | 'onSelectionEnd'
42
- | 'onPaneClick'
43
- | 'onPaneContextMenu'
44
- | 'onPaneScroll'
45
- | 'onPaneMouseEnter'
46
- | 'onPaneMouseMove'
47
- | 'onPaneMouseLeave'
48
- | 'selectionOnDrag'
49
- >
50
- >;
28
+ type PaneProps = {
29
+ isSelecting: boolean;
30
+ selectionKeyPressed: boolean;
31
+ children: OctaneNode;
32
+ paneClickDistance: number;
33
+ } & Partial<
34
+ Pick<
35
+ ReactFlowProps,
36
+ | 'selectionMode'
37
+ | 'panOnDrag'
38
+ | 'autoPanOnSelection'
39
+ | 'onSelectionStart'
40
+ | 'onSelectionEnd'
41
+ | 'onPaneClick'
42
+ | 'onPaneContextMenu'
43
+ | 'onPaneScroll'
44
+ | 'onPaneMouseEnter'
45
+ | 'onPaneMouseMove'
46
+ | 'onPaneMouseLeave'
47
+ | 'selectionOnDrag'
48
+ >
49
+ >;
51
50
 
52
- const wrapHandler = <EventType extends Event,>(
51
+ const wrapHandler = <EventType extends Event>(
53
52
  handler: EventHandler<EventType> | undefined,
54
53
  containerRef: RefObject<HTMLDivElement | null>,
55
54
  ): EventHandler<EventType> => {
@@ -112,8 +111,9 @@ export function Pane({
112
111
  // We prevent click events when the user let go of the selectionKey during a selection
113
112
  // We also prevent click events when a connection is in progress
114
113
  if (
115
- selectionInProgress.current || connectionEndedOnPane.current ||
116
- store.getState().connection.inProgress
114
+ selectionInProgress.current ||
115
+ connectionEndedOnPane.current ||
116
+ store.getState().connection.inProgress
117
117
  ) {
118
118
  selectionInProgress.current = false;
119
119
  connectionEndedOnPane.current = false;
@@ -160,10 +160,14 @@ export function Pane({
160
160
  // if a child element has the 'nokey' class, we don't want to swallow the event and don't start a selection
161
161
  const isNoKeyEvent =
162
162
  !eventTargetIsContainer && !!(event.target as HTMLElement).closest('.nokey');
163
- const isSelectionActive = selectionOnDrag && eventTargetIsContainer || selectionKeyPressed;
163
+ const isSelectionActive = (selectionOnDrag && eventTargetIsContainer) || selectionKeyPressed;
164
164
 
165
165
  if (
166
- isNoKeyEvent || !isSelecting || !isSelectionActive || event.button !== 0 || !event.isPrimary
166
+ isNoKeyEvent ||
167
+ !isSelecting ||
168
+ !isSelectionActive ||
169
+ event.button !== 0 ||
170
+ !event.isPrimary
167
171
  ) {
168
172
  return;
169
173
  }
@@ -226,13 +230,15 @@ export function Pane({
226
230
  const prevSelectedNodeIds = selectedNodeIds.current;
227
231
  const prevSelectedEdgeIds = selectedEdgeIds.current;
228
232
 
229
- selectedNodeIds.current = new Set(getNodesInside(
230
- nodeLookup,
231
- nextUserSelectRect,
232
- transform,
233
- selectionMode === SelectionMode.Partial,
234
- true,
235
- ).map((node) => node.id));
233
+ selectedNodeIds.current = new Set(
234
+ getNodesInside(
235
+ nodeLookup,
236
+ nextUserSelectRect,
237
+ transform,
238
+ selectionMode === SelectionMode.Partial,
239
+ true,
240
+ ).map((node) => node.id),
241
+ );
236
242
 
237
243
  selectedEdgeIds.current = new Set();
238
244
  const edgesSelectable = defaultEdgeOptions?.selectable ?? true;
@@ -343,12 +349,13 @@ export function Pane({
343
349
  (event.target as Partial<Element>)?.releasePointerCapture?.(event.pointerId);
344
350
 
345
351
  /*
346
- * We only want to trigger click functions when in selection mode if
347
- * the user did not move the mouse.
348
- */
352
+ * We only want to trigger click functions when in selection mode if
353
+ * the user did not move the mouse.
354
+ */
349
355
  if (
350
- !userSelectionActive && event.target === container.current &&
351
- store.getState().userSelectionRect
356
+ !userSelectionActive &&
357
+ event.target === container.current &&
358
+ store.getState().userSelectionRect
352
359
  ) {
353
360
  onClick?.(event);
354
361
  }
@@ -374,24 +381,26 @@ export function Pane({
374
381
  cleanupAutoPan();
375
382
  };
376
383
 
377
- const draggable = panOnDrag === true || Array.isArray(panOnDrag) && panOnDrag.includes(0);
378
-
379
- return <div
380
- className={cc(['react-flow__pane', { draggable, dragging, selection: isSelecting }])}
381
- onClick={isSelectionEnabled ? undefined : wrapHandler(onClick, container)}
382
- onContextMenu={wrapHandler(onContextMenu, container)}
383
- onWheel={wrapHandler(onWheel, container)}
384
- onPointerEnter={isSelectionEnabled ? undefined : onPaneMouseEnter}
385
- onPointerMove={isSelectionEnabled ? onPointerMove : onPaneMouseMove}
386
- onPointerUp={onPointerUp}
387
- onPointerCancel={isSelectionEnabled ? onPointerCancel : undefined}
388
- onPointerDownCapture={isSelectionEnabled ? onPointerDownCapture : undefined}
389
- onClickCapture={isSelectionEnabled ? onClickCapture : undefined}
390
- onPointerLeave={onPaneMouseLeave}
391
- ref={container}
392
- style={containerStyle}
393
- >
394
- {children}
395
- <UserSelection />
396
- </div>;
384
+ const draggable = panOnDrag === true || (Array.isArray(panOnDrag) && panOnDrag.includes(0));
385
+
386
+ return (
387
+ <div
388
+ className={cc(['react-flow__pane', { draggable, dragging, selection: isSelecting }])}
389
+ onClick={isSelectionEnabled ? undefined : wrapHandler(onClick, container)}
390
+ onContextMenu={wrapHandler(onContextMenu, container)}
391
+ onWheel={wrapHandler(onWheel, container)}
392
+ onPointerEnter={isSelectionEnabled ? undefined : onPaneMouseEnter}
393
+ onPointerMove={isSelectionEnabled ? onPointerMove : onPaneMouseMove}
394
+ onPointerUp={onPointerUp}
395
+ onPointerCancel={isSelectionEnabled ? onPointerCancel : undefined}
396
+ onPointerDownCapture={isSelectionEnabled ? onPointerDownCapture : undefined}
397
+ onClickCapture={isSelectionEnabled ? onClickCapture : undefined}
398
+ onPointerLeave={onPaneMouseLeave}
399
+ ref={container}
400
+ style={containerStyle}
401
+ >
402
+ {children}
403
+ <UserSelection />
404
+ </div>
405
+ );
397
406
  }
@@ -40,27 +40,29 @@ export function Wrapper({
40
40
 
41
41
  if (isWrapped) {
42
42
  /*
43
- * we need to wrap it with a fragment because it's not allowed for children to be a OctaneNode
44
- * https://github.com/DefinitelyTyped/DefinitelyTyped/issues/18051
45
- */
46
- return <>
47
- {children}
48
- </>;
43
+ * we need to wrap it with a fragment because it's not allowed for children to be a OctaneNode
44
+ * https://github.com/DefinitelyTyped/DefinitelyTyped/issues/18051
45
+ */
46
+ return <>{children}</>;
49
47
  }
50
48
 
51
- return <ReactFlowProvider
52
- initialNodes={nodes}
53
- initialEdges={edges}
54
- defaultNodes={defaultNodes}
55
- defaultEdges={defaultEdges}
56
- initialWidth={width}
57
- initialHeight={height}
58
- fitView={fitView}
59
- initialFitViewOptions={fitViewOptions}
60
- initialMinZoom={minZoom}
61
- initialMaxZoom={maxZoom}
62
- nodeOrigin={nodeOrigin}
63
- nodeExtent={nodeExtent}
64
- zIndexMode={zIndexMode}
65
- >{children}</ReactFlowProvider>;
49
+ return (
50
+ <ReactFlowProvider
51
+ initialNodes={nodes}
52
+ initialEdges={edges}
53
+ defaultNodes={defaultNodes}
54
+ defaultEdges={defaultEdges}
55
+ initialWidth={width}
56
+ initialHeight={height}
57
+ fitView={fitView}
58
+ initialFitViewOptions={fitViewOptions}
59
+ initialMinZoom={minZoom}
60
+ initialMaxZoom={maxZoom}
61
+ nodeOrigin={nodeOrigin}
62
+ nodeExtent={nodeExtent}
63
+ zIndexMode={zIndexMode}
64
+ >
65
+ {children}
66
+ </ReactFlowProvider>
67
+ );
66
68
  }