Improve TSDoc comments for BaseEdgeProps
This commit is contained in:
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
'@xyflow/react': patch
|
||||||
|
---
|
||||||
|
|
||||||
|
Improve TSDoc comments for `BaseEdgeProps`
|
||||||
@@ -148,7 +148,7 @@ export type EdgeProps<EdgeType extends Edge = Edge> = Pick<
|
|||||||
* @public
|
* @public
|
||||||
* @expand
|
* @expand
|
||||||
*/
|
*/
|
||||||
export type BaseEdgeProps = Omit<SVGAttributes<SVGPathElement>, 'd' | 'path'> &
|
export type BaseEdgeProps = Omit<SVGAttributes<SVGPathElement>, 'd' | 'path' | 'markerStart' | 'markerEnd'> &
|
||||||
EdgeLabelOptions & {
|
EdgeLabelOptions & {
|
||||||
/**
|
/**
|
||||||
* The width of the invisible area around the edge that the user can interact with. This is
|
* The width of the invisible area around the edge that the user can interact with. This is
|
||||||
@@ -166,6 +166,16 @@ export type BaseEdgeProps = Omit<SVGAttributes<SVGPathElement>, 'd' | 'path'> &
|
|||||||
* be used to generate this string for you.
|
* be used to generate this string for you.
|
||||||
*/
|
*/
|
||||||
path: string;
|
path: string;
|
||||||
|
/**
|
||||||
|
* The id of the SVG marker to use at the start of the edge. This should be defined in a
|
||||||
|
* `<defs>` element in a separate SVG document or element.
|
||||||
|
*/
|
||||||
|
markerStart?: string;
|
||||||
|
/**
|
||||||
|
* The id of the SVG marker to use at the end of the edge. This should be defined in a `<defs>`
|
||||||
|
* element in a separate SVG document or element.
|
||||||
|
*/
|
||||||
|
markerEnd?: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
Reference in New Issue
Block a user