Skip to Content
ReferenceHooks

useNodesData()

Source on GitHub

This hook lets you subscribe to changes of a specific nodes data object.

import { useNodesData } from '@xyflow/react'; export default function () { const nodeData = useNodesData('nodeId-1'); const nodesData = useNodesData(['nodeId-1', 'nodeId-2']); }

Signature

Parameters:
NameTypeDefault
nodeIdstring

The id of the node to get the data from.

Returns:
Pick<NodeType, "id" | "type" | "data"> | null

An object (or array of object) with id, type, data representing each node.

TypeScript

This hook accepts a generic type argument of custom node types. See this section in our TypeScript guide for more information.

const nodesData = useNodesData<NodesType>(['nodeId-1', 'nodeId-2']);
Last updated on