Quartz 4

85___reactflow___

16 min read

<ReactFlow />

Source on GitHub

The <ReactFlow /> component is the heart of your React Flow application. It renders your nodes and edges, handles user interaction, and can manage its own state if used as an uncontrolled flow.

import { ReactFlow } from '@xyflow/react'
 
export default function Flow() {
  return <ReactFlow
    nodes={...}
    edges={...}
    onNodesChange={...}
    ...
  />
}

This component takes a lot of different props, most of which are optional. We’ve tried to document them in groups that make sense to help you find your way.

Common props

These are the props you will most commonly use when working with React Flow. If you are working with a controlled flow with custom nodes, you will likely use almost all of these!

  • width?: number Sets a fixed width for the flow.
  • height?: number Sets a fixed height for the flow.
  • nodes?: Node[] An array of nodes to render in a controlled flow.
  • edges?: Edge[] An array of edges to render in a controlled flow.
  • defaultNodes?: Node[] The initial nodes to render in an uncontrolled flow.
  • defaultEdges?: Edge[] The initial edges to render in an uncontrolled flow.
  • paneClickDistance?: number Distance that the mouse can move between mousedown/up that will trigger a click.
  • nodeClickDistance?: number Distance that the mouse can move between mousedown/up that will trigger a click.
  • nodeTypes?: NodeTypes Custom node types to be available in a flow. React Flow matches a node’s type to a component in the nodeTypes object.
  • edgeTypes?: EdgeTypes Custom edge types to be available in a flow. React Flow matches an edge’s type to a component in the edgeTypes object.
  • autoPanOnNodeFocus?: boolean When true, the viewport will pan when a node is focused.
  • nodeOrigin?: NodeOrigin The origin of the node to use when placing it in the flow or looking up its x and y position. An origin of [0, 0] means that a node’s top left corner will be placed at the x and y position.
  • proOptions?: ProOptions By default, we render a small attribution in the corner of your flows that links back to the project.

Anyone is free to remove this attribution whether they’re a Pro subscriber or not but we ask that you take a quick look at our https://reactflow.dev/learn/troubleshooting/remove-attribution removing attribution guide before doing so.

  • nodeDragThreshold?: number With a threshold greater than zero you can delay node drag events. If threshold equals 1, you need to drag the node 1 pixel before a drag event is fired. 1 is the default value, so that clicks don’t trigger drag events.
  • connectionDragThreshold?: number The threshold in pixels that the mouse must move before a connection line starts to drag. This is useful to prevent accidental connections when clicking on a handle.
  • colorMode?: ColorMode Controls color scheme used for styling the flow.
  • debug?: boolean If set true, some debug information will be logged to the console like which events are fired.
  • ariaLabelConfig?: Partial<AriaLabelConfig> Configuration for customizable labels, descriptions, and UI text. Provided keys will override the corresponding defaults. Allows localization, customization of ARIA descriptions, control labels, minimap labels, and other UI strings.
  • ...props: Omit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "onError">

Viewport props

  • defaultViewport?: Viewport Sets the initial position and zoom of the viewport. If a default viewport is provided but fitView is enabled, the default viewport will be ignored.
  • viewport?: Viewport When you pass a viewport prop, it’s controlled, and you also need to pass onViewportChange to handle internal changes.
  • onViewportChange?: (viewport: Viewport) => void Used when working with a controlled viewport for updating the user viewport state.
  • fitView?: boolean When true, the flow will be zoomed and panned to fit all the nodes initially provided.
  • fitViewOptions?: FitViewOptionsBase<NodeType> When you typically call fitView on a ReactFlowInstance, you can provide an object of options to customize its behavior. This prop lets you do the same for the initial fitView call.
  • minZoom?: number Minimum zoom level.
  • maxZoom?: number Maximum zoom level.
  • snapToGrid?: boolean When enabled, nodes will snap to the grid when dragged.
  • snapGrid?: SnapGrid If snapToGrid is enabled, this prop configures the grid that nodes will snap to.
  • onlyRenderVisibleElements?: boolean You can enable this optimisation to instruct React Flow to only render nodes and edges that would be visible in the viewport.

This might improve performance when you have a large number of nodes and edges but also adds an overhead.

  • translateExtent?: CoordinateExtent By default, the viewport extends infinitely. You can use this prop to set a boundary. The first pair of coordinates is the top left boundary and the second pair is the bottom right.
  • nodeExtent?: CoordinateExtent By default, nodes can be placed on an infinite flow. You can use this prop to set a boundary. The first pair of coordinates is the top left boundary and the second pair is the bottom right.
  • preventScrolling?: boolean Disabling this prop will allow the user to scroll the page even when their pointer is over the flow.
  • attributionPosition?: PanelPosition By default, React Flow will render a small attribution in the bottom right corner of the flow.

You can use this prop to change its position in case you want to place something else there.

Edge props

  • elevateEdgesOnSelect?: boolean Enabling this option will raise the z-index of edges when they are selected.
  • defaultMarkerColor?: string | null Color of edge markers. You can pass null to use the CSS variable --xy-edge-stroke for the marker color.
  • defaultEdgeOptions?: DefaultEdgeOptions Defaults to be applied to all new edges that are added to the flow. Properties on a new edge will override these defaults if they exist.
  • reconnectRadius?: number The radius around an edge connection that can trigger an edge reconnection.
  • edgesReconnectable?: boolean Whether edges can be updated once they are created. When both this prop is true and an onReconnect handler is provided, the user can drag an existing edge to a new source or target. Individual edges can override this value with their reconnectable property.

Event handlers

WARNING

It’s important to remember to define any event handlers outside of your component or using React’s useCallback hook. If you don’t, this can cause React Flow to enter an infinite re-render loop!

General Events
  • onError?: OnError Occasionally something may happen that causes React Flow to throw an error.

Instead of exploding your application, we log a message to the console and then call this event handler. You might use it for additional logging or to show a message to the user.

  • onInit?: (reactFlowInstance: ReactFlowInstance<Node, Edge>) => void The onInit callback is called when the viewport is initialized. At this point you can use the instance to call methods like fitView or zoomTo.
  • onDelete?: OnDelete<Node, Edge> This event handler gets called when a node or edge is deleted.
  • onBeforeDelete?: OnBeforeDelete<Node, Edge> This handler is called before nodes or edges are deleted, allowing the deletion to be aborted by returning false or modified by returning updated nodes and edges.
Node Events
  • onNodeClick?: NodeMouseHandler<Node> This event handler is called when a user clicks on a node.
  • onNodeDoubleClick?: NodeMouseHandler<Node> This event handler is called when a user double-clicks on a node.
  • onNodeDragStart?: OnNodeDrag<Node> This event handler is called when a user starts to drag a node.
  • onNodeDrag?: OnNodeDrag<Node> This event handler is called when a user drags a node.
  • onNodeDragStop?: OnNodeDrag<Node> This event handler is called when a user stops dragging a node.
  • onNodeMouseEnter?: NodeMouseHandler<Node> This event handler is called when mouse of a user enters a node.
  • onNodeMouseMove?: NodeMouseHandler<Node> This event handler is called when mouse of a user moves over a node.
  • onNodeMouseLeave?: NodeMouseHandler<Node> This event handler is called when mouse of a user leaves a node.
  • onNodeContextMenu?: NodeMouseHandler<Node> This event handler is called when a user right-clicks on a node.
  • onNodesDelete?: OnNodesDelete<Node> This event handler gets called when a node is deleted.
  • onNodesChange?: OnNodesChange<Node> Use this event handler to add interactivity to a controlled flow. It is called on node drag, select, and move.
Edge Events
  • onEdgeClick?: (event: MouseEvent<Element, MouseEvent>, edge: Edge) => void This event handler is called when a user clicks on an edge.
  • onEdgeDoubleClick?: EdgeMouseHandler<Edge> This event handler is called when a user double-clicks on an edge.
  • onEdgeMouseEnter?: EdgeMouseHandler<Edge> This event handler is called when mouse of a user enters an edge.
  • onEdgeMouseMove?: EdgeMouseHandler<Edge> This event handler is called when mouse of a user moves over an edge.
  • onEdgeMouseLeave?: EdgeMouseHandler<Edge> This event handler is called when mouse of a user leaves an edge.
  • onEdgeContextMenu?: EdgeMouseHandler<Edge> This event handler is called when a user right-clicks on an edge.
  • onReconnect?: OnReconnect<Edge> This handler is called when the source or target of a reconnectable edge is dragged from the current node. It will fire even if the edge’s source or target do not end up changing. You can use the reconnectEdge utility to convert the connection to a new edge.
  • onReconnectStart?: (event: MouseEvent<Element, MouseEvent>, edge: Edge, handleType: HandleType) => void This event fires when the user begins dragging the source or target of an editable edge.
  • onReconnectEnd?: (event: MouseEvent | TouchEvent, edge: Edge, handleType: HandleType, connectionState: FinalConnectionState) => void This event fires when the user releases the source or target of an editable edge. It is called even if an edge update does not occur.
  • onEdgesDelete?: OnEdgesDelete<Edge> This event handler gets called when an edge is deleted.
  • onEdgesChange?: OnEdgesChange<Edge> Use this event handler to add interactivity to a controlled flow. It is called on edge select and remove.
Connection Events
  • onConnect?: OnConnect When a connection line is completed and two nodes are connected by the user, this event fires with the new connection. You can use the addEdge utility to convert the connection to a complete edge.
  • onConnectStart?: OnConnectStart This event handler gets called when a user starts to drag a connection line.
  • onConnectEnd?: OnConnectEnd This callback will fire regardless of whether a valid connection could be made or not. You can use the second connectionState parameter to have different behavior when a connection was unsuccessful.
  • onClickConnectStart?: OnConnectStart
  • onClickConnectEnd?: OnConnectEnd
  • isValidConnection?: IsValidConnection<Edge> This callback can be used to validate a new connection

If you return false, the edge will not be added to your flow. If you have custom connection logic its preferred to use this callback over the isValidConnection prop on the handle component for performance reasons.

Pane Events
  • onMove?: OnMove This event handler is called while the user is either panning or zooming the viewport.
  • onMoveStart?: OnMove This event handler is called when the user begins to pan or zoom the viewport.
  • onMoveEnd?: OnMove This event handler is called when panning or zooming viewport movement stops. If the movement is not user-initiated, the event parameter will be null.
  • onPaneClick?: (event: MouseEvent<Element, MouseEvent>) => void This event handler gets called when user clicks inside the pane.
  • onPaneContextMenu?: (event: MouseEvent | React.MouseEvent<Element, MouseEvent>) => void This event handler gets called when user right clicks inside the pane.
  • onPaneScroll?: (event?: WheelEvent<Element> | undefined) => void This event handler gets called when user scroll inside the pane.
  • onPaneMouseMove?: (event: MouseEvent<Element, MouseEvent>) => void This event handler gets called when mouse moves over the pane.
  • onPaneMouseEnter?: (event: MouseEvent<Element, MouseEvent>) => void This event handler gets called when mouse enters the pane.
  • onPaneMouseLeave?: (event: MouseEvent<Element, MouseEvent>) => void This event handler gets called when mouse leaves the pane.
Selection Events
  • onSelectionChange?: OnSelectionChangeFunc<Node, Edge> This event handler gets called when a user changes group of selected elements in the flow.
  • onSelectionDragStart?: SelectionDragHandler<Node> This event handler gets called when a user starts to drag a selection box.
  • onSelectionDrag?: SelectionDragHandler<Node> This event handler gets called when a user drags a selection box.
  • onSelectionDragStop?: SelectionDragHandler<Node> This event handler gets called when a user stops dragging a selection box.
  • onSelectionStart?: (event: MouseEvent<Element, MouseEvent>) => void
  • onSelectionEnd?: (event: MouseEvent<Element, MouseEvent>) => void
  • onSelectionContextMenu?: (event: MouseEvent<Element, MouseEvent>, nodes: Node[]) => void This event handler is called when a user right-clicks on a node selection.

Interaction props

  • nodesDraggable?: boolean Controls whether all nodes should be draggable or not. Individual nodes can override this setting by setting their draggable prop. If you want to use the mouse handlers on non-draggable nodes, you need to add the "nopan" class to those nodes.
  • nodesConnectable?: boolean Controls whether all nodes should be connectable or not. Individual nodes can override this setting by setting their connectable prop.
  • nodesFocusable?: boolean When true, focus between nodes can be cycled with the Tab key and selected with the Enter key. This option can be overridden by individual nodes by setting their focusable prop.
  • edgesFocusable?: boolean When true, focus between edges can be cycled with the Tab key and selected with the Enter key. This option can be overridden by individual edges by setting their focusable prop.
  • elementsSelectable?: boolean When true, elements (nodes and edges) can be selected by clicking on them. This option can be overridden by individual elements by setting their selectable prop.
  • autoPanOnConnect?: boolean When true, the viewport will pan automatically when the cursor moves to the edge of the viewport while creating a connection.
  • autoPanOnNodeDrag?: boolean When true, the viewport will pan automatically when the cursor moves to the edge of the viewport while dragging a node.
  • autoPanOnSelection?: boolean When true, the viewport will pan automatically when the cursor moves to the edge of the viewport while creating a selection box.
  • autoPanSpeed?: number The speed at which the viewport pans while dragging a node or a selection box.
  • panOnDrag?: boolean | number[] Enabling this prop allows users to pan the viewport by clicking and dragging. You can also set this prop to an array of numbers to limit which mouse buttons can activate panning.
  • selectionOnDrag?: boolean Select multiple elements with a selection box, without pressing down selectionKey.
  • selectionMode?: SelectionMode When set to "partial", when the user creates a selection box by click and dragging nodes that are only partially in the box are still selected.
  • panOnScroll?: boolean Controls if the viewport should pan by scrolling inside the container. Can be limited to a specific direction with panOnScrollMode.
  • panOnScrollSpeed?: number Controls how fast viewport should be panned on scroll. Use together with panOnScroll prop.
  • panOnScrollMode?: PanOnScrollMode This prop is used to limit the direction of panning when panOnScroll is enabled. The "free" option allows panning in any direction.
  • zoomOnScroll?: boolean Controls if the viewport should zoom by scrolling inside the container.
  • zoomOnPinch?: boolean Controls if the viewport should zoom by pinching on a touch screen.
  • zoomOnDoubleClick?: boolean Controls if the viewport should zoom by double-clicking somewhere on the flow.
  • selectNodesOnDrag?: boolean If true, nodes get selected on drag.
  • elevateNodesOnSelect?: boolean Enabling this option will raise the z-index of nodes when they are selected.
  • connectOnClick?: boolean The connectOnClick option lets you click or tap on a source handle to start a connection and then click on a target handle to complete the connection.

If you set this option to false, users will need to drag the connection line to the target handle to create a connection.

  • connectionMode?: ConnectionMode A loose connection mode will allow you to connect handles with differing types, including source-to-source connections. However, it does not support target-to-target connections. Strict mode allows only connections between source handles and target handles.
  • zIndexMode?: ZIndexMode Used to define how z-indexing is calculated for nodes and edges. ‘auto’ is for selections and sub flows, ‘basic’ for selections only, and ‘manual’ for no auto z-indexing.

Connection line props

  • connectionLineStyle?: CSSProperties Styles to be applied to the connection line.
  • connectionLineType?: ConnectionLineType The type of edge path to use for connection lines. Although created edges can be of any type, React Flow needs to know what type of path to render for the connection line before the edge is created!
  • connectionRadius?: number The radius around a handle where you drop a connection line to create a new edge.
  • connectionLineComponent?: ConnectionLineComponent<Node> React Component to be used as a connection line.
  • connectionLineContainerStyle?: CSSProperties Styles to be applied to the container of the connection line.

Keyboard props

React Flow let’s you pass in a few different keyboard shortcuts as another way to interact with your flow. We’ve tried to set up sensible defaults like using backspace to delete any selected nodes or edges, but you can use these props to set your own.

To disable any of these shortcuts, pass in null to the prop you want to disable.

  • deleteKeyCode?: KeyCode | null If set, pressing the key or chord will delete any selected nodes and edges. Passing an array represents multiple keys that can be pressed.

For example, ["Delete", "Backspace"] will delete selected elements when either key is pressed.

  • selectionKeyCode?: KeyCode | null If set, holding this key will let you click and drag to draw a selection box around multiple nodes and edges. Passing an array represents multiple keys that can be pressed.

For example, ["Shift", "Meta"] will allow you to draw a selection box when either key is pressed.

  • multiSelectionKeyCode?: KeyCode | null Pressing down this key you can select multiple elements by clicking.
  • zoomActivationKeyCode?: KeyCode | null If a key is set, you can zoom the viewport while that key is held down even if panOnScroll is set to false.

By setting this prop to null you can disable this functionality.

  • panActivationKeyCode?: KeyCode | null If a key is set, you can pan the viewport while that key is held down even if panOnScroll is set to false.

By setting this prop to null you can disable this functionality.

  • disableKeyboardA11y?: boolean You can use this prop to disable keyboard accessibility features such as selecting nodes or moving selected nodes with the arrow keys.

Style props

Applying certain classes to elements rendered inside the canvas will change how interactions are handled. These props let you configure those class names if you need to.

  • noPanClassName?: string If an element in the canvas does not stop mouse events from propagating, clicking and dragging that element will pan the viewport. Adding the "nopan" class prevents this behavior and this prop allows you to change the name of that class.
  • noDragClassName?: string If a node is draggable, clicking and dragging that node will move it around the canvas. Adding the "nodrag" class prevents this behavior and this prop allows you to change the name of that class.
  • noWheelClassName?: string Typically, scrolling the mouse wheel when the mouse is over the canvas will zoom the viewport. Adding the "nowheel" class to an element in the canvas will prevent this behavior and this prop allows you to change the name of that class.

Notes

  • The props of this component get exported as ReactFlowProps

Graph View