getSmoothStepPath()

Source on GitHub (opens in a new tab)

The getSmoothStepPath util returns everything you need to render a stepped path between two nodes. The borderRadius property can be used to choose how rounded the corners of those steps are.

import { Position, getSmoothStepPath } from '@xyflow/react';
 
const source = { x: 0, y: 20 };
const target = { x: 150, y: 100 };
 
const [path, labelX, labelY, offsetX, offsetY] = getSmoothStepPath({
  sourceX: source.x,
  sourceY: source.y,
  sourcePosition: Position.Right,
  targetX: target.x,
  targetY: target.y,
  targetPosition: Position.Left,
});
 
console.log(path); //=> "M0 20L20 20L 70,20Q 75,20 75,25L 75,95Q ..."
console.log(labelX, labelY); //=> 75, 60
console.log(offsetX, offsetY); //=> 75, 40

Signature

Name	Type	Default
#Params
#`sourceX`	`number`
#`sourceY`	`number`
#`sourcePosition`	`Position`	`Position.Bottom`
#`targetX`	`number`
#`targetY`	`number`
#`targetPosition?`	`Position`	`Position.Top`
#`borderRadius?`	`number`	`5`
#`centerX?`	`number`
#`centerY?`	`number`
#`offset?`	`number`	`20`
#Returns
#`[0]`	`string` The path to use in an SVG <path> element.
#`[1]`	`number` The x position you can use to render a label for this edge.
#`[2]`	`number` The y position you can use to render a label for this edge.
#`[3]`	`number` The absolute difference between the source x position and the x position of the middle of this path.
#`[4]`	`number` The absolute difference between the source y position and the y position of the middle of this path.

Notes

This function returns a tuple (aka a fixed-size array) to make it easier to work with multiple edge paths at once.
You can set the borderRadius property to 0 to get a step edge path.

getSimpleBezierPath()getStraightPath()