xyflow/react-flow-docs

⚠️ This repo contains old versions of the React Flow website. The new repo is located at:

react-flow-docs's Issues

Clarification on useReactFlow docs

The code example for useReactFlow hook does not in fact use a hook called useReactFlow. Is the doc up to date?

Examples: use BaseEdge for examples with custom edges

MiniMap: add docs for custom mini map node component

add docs for custom mini map node component

Document how to add mouse events when nodes are not draggable

-> xyflow/xyflow#2525

Switch from npm to pnpm

Because Moritz is sitting next to me and told me this would be a good idea, unfortunately I don't know the difference between the two.

New Example: delete node between two nodes

Create a new edge when a node between two nodes gets deleted.

Wrong description in "Stress" example

https://github.com/wbkd/react-flow-docs/blob/main/docs/examples/stress.mdx

The description is mistakenly from the "Save and Restore" example.

PS: Same issue in "Smooth Transition".

Duplicated props in the doc

Hi, Duplicated autoPanOnConnect and autoPanOnNodeDrag are in the doc (https://reactflow.dev/docs/api/react-flow-props/#panondrag).

Quickstart fails as written due to "Minimap" component

https://reactflow.dev/docs/quickstart/#some-extra-goodies directs the learner to use a Minimap component, but the component is named MiniMap (see https://reactflow.dev/docs/api/plugin-components/minimap/). The page fails to render due to this error and the browser console identifies Minimap as unknown.

Changing the import and the component to MiniMap solves the problem.

Warning in Custom Node example

https://reactflow.dev/docs/guides/custom-nodes/
The last example shown in the documentation uses the same key (edge-1) for both edges hence throwing some warnings

Broken example link in `getConnectedEdges()` of "Graph Util Functions"

In "Graph Utils Functions" -> getConnectedEdges(), the "this example" link points to this dead link: https://github.com/wbkd/react-flow/blob/main/example/src/Overview/index.tsx#L100.

Is it possible to update the example link, if the example still exists? Thank you very much!

Initialization issue In the Drag and Drop

Url: https://reactflow.dev/docs/examples/interaction/drag-and-drop/

If you remove the initial node in the example - that is, start without initial nodes deployed -, when you drag and drop the first node it will be dropped in the centered position instead of the position the user dropped it (it will be positioned as if it were the initial node of the example).

For this you only need to change useNodesState(initialNodes) to useNodesState([]). Looks like some initialization issue, any help is greatly appreciated.

Nuno

Dagre node use x y for node center rather than vertex coordinate

The example code seems to behave incorrectly when there is difference in nodes size. Here's the link for example code:

https://github.com/wbkd/react-flow-docs/blob/fe57d8b54a21d8b1da0f0ba3c03b380f792ce758/src/components/CodeViewer/api-flows/LayoutingFlow2-Dagre/index.js#L28C35-L28C35

It should be like:

return { ...node, position: { x: x - node.width / 2, y: y - node.height / 2 } };

Typo: "evetything" on `/docs/getting-started/adding-interactivity/`

https://github.com/wbkd/react-flow-docs/blame/fe57d8b54a21d8b1da0f0ba3c03b380f792ce758/docs/getting-started/adding-interactivity.md#L41C187-L41C197

The link is not valid

The File is not found linked to the store in the Internal actions in https://reactflow.dev/docs/api/hooks/use-store/

Main page crashes

Tried running project locally and on incognito, works fine, but crashes on https://reactflow.dev/ , i think the issue is related webgl not being loaded for the hero banner section animation