Skip to Content
Vue Flow v2 is here and joins xyflow! Read more here →
ReferenceTypes

BaseEdgeProps

The BaseEdgeProps type is the set of props accepted by the <BaseEdge /> component — the SVG path, the label and its position, markers, and the interaction width.

Fields

NameTypeDefault
idstring

Unique id of an edge.

labelXnumber

The x position of edge label.

labelYnumber

The y position of edge label.

pathstring

The SVG path string that defines the edge. This should look something like 'M 0 0 L 100 100' for a simple line.

labelstring | VNode<RendererNode, RendererElement, { [key: string]: any; }> | Component<EdgeTextProps>
markerStartstring

The id of the SVG marker to use at the start of the edge. This should be defined in a <defs> element. Use the format “url(#markerId)” where markerId is the id of your marker definition.

markerEndstring

The id of the SVG marker to use at the end of the edge. This should be defined in a <defs> element. Use the format “url(#markerId)” where markerId is the id of your marker definition.

interactionWidthnumber

The width of the invisible area around the edge that the user can interact with. This is useful for making the edge easier to click or hover over.

20
labelStyleCSSProperties

Custom styles to apply to the label.

labelShowBgboolean

Render a background rectangle behind the label.

labelBgStyleCSSProperties

Inline style applied to the label background rectangle.

labelBgPadding[number, number]

Padding around the label inside its background, as [x, y] in pixels.

labelBgBorderRadiusnumber

Border radius of the label background, in pixels.