From 4ef93d611fc82b0d6b289ded79da9018b213b7cd Mon Sep 17 00:00:00 2001 From: Ilia <43846662+ibagov@users.noreply.github.com> Date: Sat, 5 Apr 2025 14:35:35 +0200 Subject: [PATCH 1/2] Update onNodesChange docstring in component-props.ts Removed all references of edges in the docstring of onNodesChange --- packages/react/src/types/component-props.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/react/src/types/component-props.ts b/packages/react/src/types/component-props.ts index d558bc47..630fc4f3 100644 --- a/packages/react/src/types/component-props.ts +++ b/packages/react/src/types/component-props.ts @@ -137,16 +137,16 @@ export interface ReactFlowProps void; /** * This event handler is called when a Node is updated - * @example // Use NodesState hook to create edges and get onNodesChange handler + * @example // Use NodesState hook to create nodes and get onNodesChange handler * import ReactFlow, { useNodesState } from '@xyflow/react'; - * const [edges, setNodes, onNodesChange] = useNodesState(initialNodes); + * const [nodes, setNodes, onNodesChange] = useNodesState(initialNodes); * * return () - * @example // Use helper function to update edge + * @example // Use helper function to update node * import ReactFlow, { applyNodeChanges } from '@xyflow/react'; * * const onNodeChange = useCallback( - * (changes) => setNode((eds) => applyNodeChanges(changes, eds)), + * (changes) => setNode((nds) => applyNodeChanges(changes, nds)), * [], * ); * From d02371662669aab91cd2ac7c45b412491c3377bd Mon Sep 17 00:00:00 2001 From: moklick Date: Mon, 7 Apr 2025 11:24:44 +0200 Subject: [PATCH 2/2] chore(changesets): add --- .changeset/curly-kangaroos-clap.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/curly-kangaroos-clap.md diff --git a/.changeset/curly-kangaroos-clap.md b/.changeset/curly-kangaroos-clap.md new file mode 100644 index 00000000..c2e617fc --- /dev/null +++ b/.changeset/curly-kangaroos-clap.md @@ -0,0 +1,5 @@ +--- +'@xyflow/react': patch +--- + +Improve `onNodesChange` docs