Merge pull request #335 from wbkd/develop

Develop

README.md

@@ -155,6 +155,7 @@ Node example: `{ id: '1', type: 'input', data: { label: 'Node 1' }, position: {
 - `className`: additional class name
 - `targetPosition`: 'left' | 'right' | 'top' | 'bottom' handle position - default: 'top'
 - `sourcePosition`: 'left' | 'right' | 'top' | 'bottom' handle position - default: 'bottom'
+- `isHidden`: if `true` node gets not rendered
 
 ## Node Types & Custom Nodes
 
@@ -251,6 +252,7 @@ If you wanted to display this edge, you would need a node with id = 1 (source no
 - `labelBgStyle`: css properties for the text background
 - `arrowHeadType`: 'arrow' or 'arrowclosed' - defines the arrowhead of the edge
 - `markerEndId`: custom marker end url - if this is used `arrowHeadType` gets ignored
+- `isHidden`: if `true` edge gets not rendered
 
 You can find an example with lots of different edges in the [edges example](https://react-flow.netlify.app/edges).
 

cypress/integration/flow/basic.spec.js

@@ -1,4 +1,4 @@
-describe('Basic Graph Rendering', () => {
+describe('Basic Flow Rendering', () => {
   it('renders a flow with three nodes', () => {
     cy.visit('/basic');
 

cypress/integration/flow/custom-node.js

@@ -1,5 +1,5 @@
-describe('Custom Node Graph Rendering', () => {
-  it('renders a graph', () => {
+describe('Custom Node Flow Rendering', () => {
+  it('renders a flow', () => {
     cy.visit('/custom-node');
 
     cy.get('.react-flow__renderer');

cypress/integration/flow/empty.spec.js

@@ -1,5 +1,5 @@
 describe('Empty Flow Rendering', () => {
-  it('renders an empty graph', () => {
+  it('renders an empty flow', () => {
     cy.visit('/empty');
 
     cy.get('.react-flow__renderer');

cypress/integration/flow/hidden.spec.js

@@ -0,0 +1,30 @@
+describe('Hidden Flow Rendering', () => {
+  it('renders the initial flow', () => {
+    cy.visit('/hidden');
+
+    cy.get('.react-flow__renderer');
+    cy.get('.react-flow__node').should('have.length', 4);
+    cy.get('.react-flow__edge').should('have.length', 3);
+    cy.get('.react-flow__minimap-node').should('have.length', 4);
+  });
+
+  it('toggles isHidden mode', () => {
+    cy.get('.react-flow__ishidden').click();
+  });
+
+  it('renders empty flow', () => {
+    cy.get('.react-flow__node').should('not.exist');
+    cy.get('.react-flow__edge').should('not.exist');
+    cy.get('.react-flow__minimap-node').should('not.exist');
+  });
+
+  it('toggles isHidden mode again', () => {
+    cy.get('.react-flow__ishidden').click();
+  });
+
+  it('renders initial flow', () => {
+    cy.get('.react-flow__node').should('have.length', 4);
+    cy.get('.react-flow__edge').should('have.length', 3);
+    cy.get('.react-flow__minimap-node').should('have.length', 4);
+  });
+});

cypress/integration/flow/interaction.spec.js

@@ -1,5 +1,5 @@
-describe('Interaction Graph Rendering', () => {
-  it('renders a graph', () => {
+describe('Interaction Flow Rendering', () => {
+  it('renders initial flow', () => {
     cy.visit('/interaction');
 
     cy.get('.react-flow__renderer');

cypress/integration/flow/overview.spec.js

@@ -1,5 +1,5 @@
-describe('Overview Graph Rendering', () => {
-  it('renders a graph', () => {
+describe('Overview Flow Rendering', () => {
+  it('renders a flow', () => {
     cy.visit('/');
 
     cy.get('.react-flow__renderer');

cypress/integration/flow/stress.spec.js

@@ -1,5 +1,5 @@
-describe('Stress Graph Rendering', () => {
-  it('renders a graph', () => {
+describe('Stress Flow Rendering', () => {
+  it('renders initial flow', () => {
     cy.visit('/stress');
 
     cy.get('.react-flow__renderer');

example/src/Basic/index.js

@@ -2,9 +2,9 @@ import React, { useState } from 'react';
 
 import ReactFlow, { removeElements, addEdge, isNode, Background } from 'react-flow-renderer';
 
-const onNodeDragStop = node => console.log('drag stop', node);
-const onLoad = reactFlowInstance => console.log('graph loaded:', reactFlowInstance);
-const onElementClick = element => console.log('click', element);
+const onNodeDragStop = (node) => console.log('drag stop', node);
+const onLoad = (reactFlowInstance) => console.log('flow loaded:', reactFlowInstance);
+const onElementClick = (element) => console.log('click', element);
 
 const initialElements = [
   { id: '1', type: 'input', data: { label: 'Node 1' }, position: { x: 250, y: 5 } },
@@ -17,20 +17,19 @@ const initialElements = [
 
 const BasicFlow = () => {
   const [elements, setElements] = useState(initialElements);
-  const onElementsRemove = (elementsToRemove) =>
-    setElements(els => removeElements(elementsToRemove, els));
-  const onConnect = (params) => setElements(els => addEdge(params, els));
+  const onElementsRemove = (elementsToRemove) => setElements((els) => removeElements(elementsToRemove, els));
+  const onConnect = (params) => setElements((els) => addEdge(params, els));
 
   const updatePos = () => {
-    setElements(elms => {
-      return elms.map(el => {
+    setElements((elms) => {
+      return elms.map((el) => {
         if (isNode(el)) {
           return {
             ...el,
             position: {
               x: Math.random() * 400,
-              y: Math.random() * 400
-            }
+              y: Math.random() * 400,
+            },
           };
         }
 
@@ -54,14 +53,11 @@ const BasicFlow = () => {
     >
       <Background variant="lines" />
 
-      <button
-        onClick={updatePos}
-        style={{ position: 'absolute', right: 10, top: 30, zIndex: 4 }}
-      >
+      <button onClick={updatePos} style={{ position: 'absolute', right: 10, top: 30, zIndex: 4 }}>
         change pos
       </button>
     </ReactFlow>
   );
-}
+};
 
 export default BasicFlow;

example/src/CustomNode/index.js

@@ -6,7 +6,7 @@ import ColorSelectorNode from './ColorSelectorNode';
 
 const onNodeDragStop = (node) => console.log('drag stop', node);
 const onElementClick = (element) => console.log('click', element);
-const onLoad = (reactFlowInstance) => console.log('graph loaded:', reactFlowInstance);
+const onLoad = (reactFlowInstance) => console.log('flow loaded:', reactFlowInstance);
 
 const initBgColor = '#f0e742';
 

example/src/Empty/index.js

@@ -2,23 +2,22 @@ import React, { useState } from 'react';
 
 import ReactFlow, { removeElements, addEdge, MiniMap, Controls, Background } from 'react-flow-renderer';
 
-const onNodeDragStop = node => console.log('drag stop', node);
-const onLoad = reactFlowInstance => console.log('graph loaded:', reactFlowInstance);
-const onElementClick = element => console.log('click', element);
+const onNodeDragStop = (node) => console.log('drag stop', node);
+const onLoad = (reactFlowInstance) => console.log('flow loaded:', reactFlowInstance);
+const onElementClick = (element) => console.log('click', element);
 
 const EmptyFlow = () => {
   const [elements, setElements] = useState([]);
-  const onElementsRemove = (elementsToRemove) =>
-    setElements(els => removeElements(elementsToRemove, els));
-  const onConnect = (params) => setElements(els => addEdge(params, els));
+  const onElementsRemove = (elementsToRemove) => setElements((els) => removeElements(elementsToRemove, els));
+  const onConnect = (params) => setElements((els) => addEdge(params, els));
   const addRandomNode = () => {
     const nodeId = (elements.length + 1).toString();
     const newNode = {
       id: nodeId,
       data: { label: `Node: ${nodeId}` },
-      position: { x: Math.random() * window.innerWidth, y: Math.random() * window.innerHeight }
+      position: { x: Math.random() * window.innerWidth, y: Math.random() * window.innerHeight },
     };
-    setElements(els => els.concat(newNode));
+    setElements((els) => els.concat(newNode));
   };
 
   return (
@@ -27,22 +26,18 @@ const EmptyFlow = () => {
       onLoad={onLoad}
       onElementClick={onElementClick}
       onElementsRemove={onElementsRemove}
-      onConnect={p => onConnect(p)}
+      onConnect={(p) => onConnect(p)}
       onNodeDragStop={onNodeDragStop}
     >
       <MiniMap />
       <Controls />
       <Background variant="lines" />
 
-      <button
-        type="button"
-        onClick={addRandomNode}
-        style={{ position: 'absolute', left: 10, top: 10, zIndex: 4 }}
-      >
+      <button type="button" onClick={addRandomNode} style={{ position: 'absolute', left: 10, top: 10, zIndex: 4 }}>
         add node
       </button>
     </ReactFlow>
   );
-}
+};
 
 export default EmptyFlow;

example/src/Hidden/index.js

@@ -0,0 +1,55 @@
+import React, { useState } from 'react';
+
+import ReactFlow, { addEdge, MiniMap, Controls } from 'react-flow-renderer';
+import { useEffect } from 'react';
+
+const initialElements = [
+  { id: '1', type: 'input', data: { label: 'Node 1' }, position: { x: 250, y: 5 } },
+  { id: '2', data: { label: 'Node 2' }, position: { x: 100, y: 100 } },
+  { id: '3', data: { label: 'Node 3' }, position: { x: 400, y: 100 } },
+  { id: '4', data: { label: 'Node 4' }, position: { x: 400, y: 200 } },
+  { id: 'e1-2', source: '1', target: '2' },
+  { id: 'e1-3', source: '1', target: '3' },
+  { id: 'e3-4', source: '3', target: '4' },
+];
+
+const HiddenFlow = () => {
+  const [elements, setElements] = useState(initialElements);
+  const [isHidden, setIsHidden] = useState(false);
+  const onConnect = (params) => setElements((els) => addEdge(params, els));
+
+  useEffect(() => {
+    setElements((els) =>
+      els.map((e) => {
+        e.isHidden = isHidden;
+        return e;
+      })
+    );
+  }, [isHidden]);
+
+  console.log(elements);
+
+  return (
+    <ReactFlow elements={elements} onConnect={onConnect}>
+      <MiniMap />
+      <Controls />
+
+      <div style={{ position: 'absolute', left: 10, top: 10, zIndex: 4 }}>
+        <div>
+          <label htmlFor="ishidden">
+            isHidden
+            <input
+              id="ishidden"
+              type="checkbox"
+              checked={isHidden}
+              onChange={(evt) => setIsHidden(evt.target.checked)}
+              className="react-flow__ishidden"
+            />
+          </label>
+        </div>
+      </div>
+    </ReactFlow>
+  );
+};
+
+export default HiddenFlow;

example/src/Overview/index.js

@@ -7,7 +7,7 @@ const onNodeDragStop = (node) => console.log('drag stop', node);
 const onElementClick = (element) => console.log('click', element);
 const onSelectionChange = (elements) => console.log('selection change', elements);
 const onLoad = (reactFlowInstance) => {
-  console.log('graph loaded:', reactFlowInstance);
+  console.log('flow loaded:', reactFlowInstance);
   reactFlowInstance.fitView();
 };
 

example/src/Stress/index.js

@@ -3,30 +3,29 @@ import React, { useState } from 'react';
 import ReactFlow, { removeElements, addEdge, MiniMap, isNode, Controls, Background } from 'react-flow-renderer';
 import { getElements } from './utils';
 
-const onLoad = reactFlowInstance => {
+const onLoad = (reactFlowInstance) => {
   reactFlowInstance.fitView();
 
   console.log(reactFlowInstance.getElements());
-}
+};
 
 const initialElements = getElements(10, 10);
 
-const StressGraph = () => {
+const StressFlow = () => {
   const [elements, setElements] = useState(initialElements);
-  const onElementsRemove = (elementsToRemove) =>
-    setElements(els => removeElements(elementsToRemove, els));
-  const onConnect = (params) => setElements(els => addEdge(params, els));
+  const onElementsRemove = (elementsToRemove) => setElements((els) => removeElements(elementsToRemove, els));
+  const onConnect = (params) => setElements((els) => addEdge(params, els));
 
   const updatePos = () => {
-    setElements(elms => {
-      return elms.map(el => {
+    setElements((elms) => {
+      return elms.map((el) => {
         if (isNode(el)) {
           return {
             ...el,
             position: {
               x: Math.random() * window.innerWidth,
-              y: Math.random() * window.innerHeight
-            }
+              y: Math.random() * window.innerHeight,
+            },
           };
         }
 
@@ -36,24 +35,16 @@ const StressGraph = () => {
   };
 
   return (
-    <ReactFlow
-      elements={elements}
-      onLoad={onLoad}
-      onElementsRemove={onElementsRemove}
-      onConnect={onConnect}
-    >
+    <ReactFlow elements={elements} onLoad={onLoad} onElementsRemove={onElementsRemove} onConnect={onConnect}>
       <MiniMap />
       <Controls />
       <Background />
 
-      <button
-        onClick={updatePos}
-        style={{ position: 'absolute', right: 10, top: 30, zIndex: 4 }}
-      >
+      <button onClick={updatePos} style={{ position: 'absolute', right: 10, top: 30, zIndex: 4 }}>
         change pos
       </button>
     </ReactFlow>
   );
-}
+};
 
-export default StressGraph;
+export default StressFlow;

example/src/index.js

@@ -12,6 +12,7 @@ import Edges from './Edges';
 import Validation from './Validation';
 import Horizontal from './Horizontal';
 import Provider from './Provider';
+import Hidden from './Hidden';
 
 import './index.css';
 
@@ -51,6 +52,11 @@ const routes = [
     component: Stress,
     label: 'Stress',
   },
+  {
+    path: '/interaction',
+    component: Interaction,
+    label: 'Interaction',
+  },
   {
     path: '/basic',
     component: Basic,
@@ -60,9 +66,8 @@ const routes = [
     component: Empty,
   },
   {
-    path: '/interaction',
-    component: Interaction,
-    label: 'Interaction',
+    path: '/hidden',
+    component: Hidden,
   },
 ];
 

src/additional-components/MiniMap/index.tsx

@@ -63,9 +63,11 @@ const MiniMap = ({
       style={style}
       className={mapClasses}
     >
-      {nodes.map((node) => (
-        <MiniMapNode key={node.id} node={node} color={nodeColorFunc(node)} borderRadius={nodeBorderRadius} />
-      ))}
+      {nodes
+        .filter((node) => !node.isHidden)
+        .map((node) => (
+          <MiniMapNode key={node.id} node={node} color={nodeColorFunc(node)} borderRadius={nodeBorderRadius} />
+        ))}
       <path
         className="react-flow__minimap-mask"
         d={`M${x - offset},${y - offset}h${width + offset * 2}v${height + offset * 2}h${-width - offset * 2}z

src/components/Edges/wrapEdge.tsx

@@ -18,6 +18,7 @@ interface EdgeWrapperProps {
   animated?: boolean;
   selected: boolean;
   elementsSelectable: boolean;
+  isHidden?: boolean;
 }
 
 export default (EdgeComponent: ComponentType<EdgeCompProps>) => {
@@ -36,9 +37,15 @@ export default (EdgeComponent: ComponentType<EdgeCompProps>) => {
       labelShowBg,
       labelBgStyle,
       className,
+      isHidden,
       ...rest
     }: EdgeWrapperProps) => {
       const setSelectedElements = useStoreActions((a) => a.setSelectedElements);
+
+      if (isHidden) {
+        return null;
+      }
+
       const edgeClasses = cc(['react-flow__edge', `react-flow__edge-${type}`, className, { selected, animated }]);
       const edgeGroupStyle: CSSProperties = {
         pointerEvents: elementsSelectable ? 'all' : 'none',

src/components/Nodes/wrapNode.tsx

@@ -184,6 +184,7 @@ export default (NodeComponent: ComponentType<NodeComponentProps>) => {
       selectNodesOnDrag,
       sourcePosition,
       targetPosition,
+      isHidden,
     }: WrapNodeProps) => {
       const updateNodeDimensions = useStoreActions((a) => a.updateNodeDimensions);
       const setSelectedElements = useStoreActions((a) => a.setSelectedElements);
@@ -243,13 +244,6 @@ export default (NodeComponent: ComponentType<NodeComponentProps>) => {
         return noop;
       }, [isSelectable, isDraggable, id, type]);
 
-      const nodeStyle: CSSProperties = {
-        zIndex: selected ? 10 : 3,
-        transform: `translate(${xPos}px,${yPos}px)`,
-        pointerEvents: isSelectable || isDraggable ? 'all' : 'none',
-        ...style,
-      };
-
       useEffect(() => {
         if (nodeElement.current) {
           updateNodeDimensions({ id, nodeElement: nodeElement.current });
@@ -271,6 +265,17 @@ export default (NodeComponent: ComponentType<NodeComponentProps>) => {
 
         return;
       }, [id]);
+      console.log(isHidden);
+      if (isHidden) {
+        return null;
+      }
+
+      const nodeStyle: CSSProperties = {
+        zIndex: selected ? 10 : 3,
+        transform: `translate(${xPos}px,${yPos}px)`,
+        pointerEvents: isSelectable || isDraggable ? 'all' : 'none',
+        ...style,
+      };
 
       return (
         <DraggableCore

src/container/EdgeRenderer/index.tsx

@@ -187,6 +187,7 @@ function renderEdge(
       targetPosition={targetPosition}
       elementsSelectable={elementsSelectable}
       markerEndId={props.markerEndId}
+      isHidden={edge.isHidden}
     />
   );
 }

src/container/NodeRenderer/index.tsx

@@ -59,6 +59,7 @@ function renderNode(
       sourcePosition={node.sourcePosition}
       targetPosition={node.targetPosition}
       selectNodesOnDrag={props.selectNodesOnDrag}
+      isHidden={node.isHidden}
     />
   );
 }

src/hooks/useElementUpdater.ts

@@ -29,6 +29,7 @@ const useElementUpdater = (elements: Elements): void => {
           : existingNode.style;
 
         const className = existingNode.className === propNode.className ? existingNode.className : propNode.className;
+        const isHidden = existingNode.isHidden === propNode.isHidden ? existingNode.isHidden : propNode.isHidden;
 
         const positionChanged =
           existingNode.position.x !== propNode.position.x || existingNode.position.y !== propNode.position.y;
@@ -54,6 +55,10 @@ const useElementUpdater = (elements: Elements): void => {
           nodeProps.className = className;
         }
 
+        if (typeof isHidden !== 'undefined') {
+          nodeProps.isHidden = isHidden;
+        }
+
         return nodeProps;
       }
 

src/types/index.ts

@@ -40,6 +40,7 @@ export interface Node {
   className?: string;
   targetPosition?: Position;
   sourcePosition?: Position;
+  isHidden?: boolean;
 }
 
 export enum ArrowHeadType {
@@ -59,6 +60,7 @@ export interface Edge {
   style?: CSSProperties;
   animated?: boolean;
   arrowHeadType?: ArrowHeadType;
+  isHidden?: boolean;
 }
 
 export enum BackgroundVariant {
@@ -151,6 +153,7 @@ export interface WrapNodeProps {
   className?: string;
   sourcePosition?: Position;
   targetPosition?: Position;
+  isHidden?: boolean;
 }
 
 export type FitViewParams = {