@vue-flow/monorepo • Docs

---

Interface: Node<Data, CustomEvents, Type>

Extended by

• GraphNode

Type Parameters

• Data = ElementData

• CustomEvents extends Record<string, CustomEvent> = any

• Type extends string = string

Properties

ariaLabel?

optional ariaLabel: string

---

class?

optional class: string | string[] | Record<string, any> | ClassFunc<GraphNode<Data, CustomEvents, string>>

Additional class names, can be a string or a callback returning a string (receives current flow element)

---

connectable?

optional connectable: HandleConnectable

Disable/enable connecting node

---

data?

optional data: Data

Additional data that is passed to your custom components

---

deletable?

optional deletable: boolean

Disable/enable deleting node

---

draggable?

optional draggable: boolean

Disable/enable dragging node

---

dragHandle?

optional dragHandle: string

element selector as drag handle for node (can only be dragged from the dragHandle el)

---

events?

optional events: Partial<NodeEventsHandler<CustomEvents>>

Deprecated

• will be removed in the next major release contextual and custom events that are passed to your custom components

---

expandParent?

optional expandParent: boolean

expands parent area to fit child node

---

extent?

optional extent: CoordinateExtent | CoordinateExtentRange | "parent"

define node extent, i.e. area in which node can be moved

---

focusable?

optional focusable: boolean

Disable/enable focusing node (a11y)

---

height?

optional height: string | number | HeightFunc

Fixed height of node, applied as style You can pass a number which will be used in pixel values (height: 300 -> height: 300px) or pass a string with units (height: 10rem -> height: 10rem)

---

hidden?

optional hidden: boolean

Is node hidden

---

id

id: string

Unique node id

---

isValidSourcePos?

optional isValidSourcePos: ValidConnectionFunc

Deprecated

will be removed in next major release called when used as source for new connection

---

isValidTargetPos?

optional isValidTargetPos: ValidConnectionFunc

Deprecated

will be removed in next major release called when used as target for new connection

---

label?

optional label: string | VNode<RendererNode, RendererElement, object> | Component

Deprecated

• will be removed in next major release and replaced with { data: { label: string | VNode | Component } } A node label

---

parentNode?

optional parentNode: string

todo: rename to parentId in next major release define node as a child node by setting a parent node id

---

position

position: XYPosition

initial node position x, y

---

selectable?

optional selectable: boolean

Disable/enable selecting node

---

sourcePosition?

optional sourcePosition: Position

handle position

---

style?

optional style: Styles | StyleFunc<GraphNode<Data, CustomEvents, string>>

Additional styles, can be an object or a callback returning an object (receives current flow element)

---

targetPosition?

optional targetPosition: Position

handle position

---

template?

optional template: NodeComponent

Deprecated

• will be removed in the next major release overwrites current node type

---

type?

optional type: Type

node type, can be a default type or a custom type

---

width?

optional width: string | number | WidthFunc

Fixed width of node, applied as style You can pass a number which will be used in pixel values (width: 300 -> width: 300px) or pass a string with units (width: 10rem -> width: 10rem)

---

zIndex?

optional zIndex: number