alighasami/xyflow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #5141 from dimaMachina/tsdoc-7

Browse Source 
fix: improve TSDoc comments for `Edge`, `BaseEdgeProps` and `ConnectionLineComponentProps`
This commit is contained in:
Moritz Klack
2025-04-02 13:30:14 +02:00
committed by GitHub
parent d0e2548983 e95f8db11d
commit 8befd1384e
2 changed files with 21 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
.changeset/twenty-cobras-teach.md Normal file
View File

@@ -0,0 +1,5 @@
---
'@xyflow/react': patch
---
fix: improve TSDoc comments for `Edge`, `BaseEdgeProps` and `ConnectionLineComponentProps`

24
packages/react/src/types/edges.ts
View File

@@ -50,6 +50,11 @@ export type Edge<
EdgeLabelOptions & {
style?: CSSProperties;
className?: string;
/**
* Determines whether the edge can be updated by dragging the source or target to a new node.
* This property will override the default set by the `edgesReconnectable` prop on the
* `<ReactFlow />` component.
*/
reconnectable?: boolean | HandleType;
focusable?: boolean;
};
@@ -109,15 +114,11 @@ export type EdgeWrapperProps<EdgeType extends Edge = Edge> = {
*/
export type DefaultEdgeOptions = DefaultEdgeOptionsBase<Edge>;
export type EdgeTextProps = SVGAttributes<SVGElement> &
export type EdgeTextProps = Omit<SVGAttributes<SVGElement>, 'x' | 'y'> &
EdgeLabelOptions & {
/**
* The x position where the label should be rendered.
*/
/** The x position where the label should be rendered. */
x: number;
/**
* The y position where the label should be rendered.
*/
/** The y position where the label should be rendered. */
y: number;
};
@@ -147,11 +148,12 @@ export type EdgeProps<EdgeType extends Edge = Edge> = Pick<
* @public
* @expand
*/
export type BaseEdgeProps = Omit<SVGAttributes<SVGPathElement>, 'd'> &
export type BaseEdgeProps = Omit<SVGAttributes<SVGPathElement>, 'd' | 'path'> &
EdgeLabelOptions & {
/**
* 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.
* @default 20
*/
interactionWidth?: number;
/** The x position of edge label */
@@ -233,7 +235,9 @@ export type OnReconnect<EdgeType extends Edge = Edge> = (oldEdge: EdgeType, newC
export type ConnectionLineComponentProps<NodeType extends Node = Node> = {
connectionLineStyle?: CSSProperties;
connectionLineType: ConnectionLineType;
/** The node the connection line originates from. */
fromNode: InternalNode<NodeType>;
/** The handle on the `fromNode` that the connection line originates from. */
fromHandle: Handle;
fromX: number;
fromY: number;
@@ -241,6 +245,10 @@ export type ConnectionLineComponentProps<NodeType extends Node = Node> = {
toY: number;
fromPosition: Position;
toPosition: Position;
/**
* If there is an `isValidConnection` callback, this prop will be set to `"valid"` or `"invalid"`
* based on the return value of that callback. Otherwise, it will be `null`.
*/
connectionStatus: 'valid' | 'invalid' | null;
toNode: InternalNode<NodeType> | null;
toHandle: Handle | null;