@vue-flow/monorepo • Docs

---

Interface: EdgeProps<Data, CustomEvents, Type>

these props are passed to edge components

Extends

• EdgeLabelOptions.EdgePositions

Type Parameters

• Data = ElementData

• CustomEvents = object

• Type extends string = string

Properties

animated?

optional animated: boolean

---

curvature?

optional curvature: number

---

data

data: Data

---

events

events: EdgeEventsOn<CustomEvents>

contextual and custom events of edge

---

id

id: string

---

interactionWidth?

optional interactionWidth: number

---

label?

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

---

labelBgBorderRadius?

optional labelBgBorderRadius: number

Label Bg border radius

Inherited from

EdgeLabelOptions.labelBgBorderRadius

---

labelBgPadding?

optional labelBgPadding: [number, number]

Label Bg padding

Inherited from

EdgeLabelOptions.labelBgPadding

---

labelBgStyle?

optional labelBgStyle: CSSProperties

Label Bg styles (CSSProperties)

Inherited from

EdgeLabelOptions.labelBgStyle

---

labelShowBg?

optional labelShowBg: boolean

Show label bg

Inherited from

EdgeLabelOptions.labelShowBg

---

labelStyle?

optional labelStyle: CSSProperties

Label styles (CSSProperties)

Inherited from

EdgeLabelOptions.labelStyle

---

markerEnd

markerEnd: string

---

markerStart

markerStart: string

---

selected?

optional selected: boolean

---

source

source: string

---

sourceHandleId?

optional sourceHandleId: string

---

sourceNode

sourceNode: GraphNode<any, any, string>

---

sourcePosition

sourcePosition: Position

---

sourceX

sourceX: number

Inherited from

EdgePositions.sourceX

---

sourceY

sourceY: number

Inherited from

EdgePositions.sourceY

---

style?

optional style: CSSProperties

---

target

target: string

---

targetHandleId?

optional targetHandleId: string

---

targetNode

targetNode: GraphNode<any, any, string>

---

targetPosition

targetPosition: Position

---

targetX

targetX: number

Inherited from

EdgePositions.targetX

---

targetY

targetY: number

Inherited from

EdgePositions.targetY

---

type

type: Type

---

updatable?

optional updatable: boolean