NodeChange

Source on GitHub

The onNodesChange callback takes an array of NodeChange objects that you should use to update your flow’s state. The NodeChange type is a union of six different object types that represent that various ways an node can change in a flow.

export type NodeChange =
  | NodeDimensionChange
  | NodePositionChange
  | NodeSelectionChange
  | NodeRemoveChange
  | NodeAddChange
  | NodeReplaceChange;

Variant types

NodeDimensionChange
  • id: string
  • type: "dimensions"
  • dimensions?: Dimensions
  • resizing?: boolean
  • setAttributes?: boolean | "width" | "height"
NodePositionChange
  • id: string
  • type: "position"
  • position?: XYPosition
  • positionAbsolute?: XYPosition
  • dragging?: boolean
NodeSelectionChange
  • id: string
  • type: "select"
  • selected: boolean
NodeRemoveChange
  • id: string
  • type: "remove"
NodeAddChange
  • item: NodeType
  • type: "add"
  • index?: number
NodeReplaceChange
  • id: string
  • item: NodeType
  • type: "replace"