Merge pull request #5557 from xyflow/chore/tsdocs-adjustments

chore(tsdocs): adjustments
This commit is contained in:
Moritz Klack
2025-10-21 14:49:27 +02:00
committed by GitHub
2 changed files with 12 additions and 12 deletions
+10 -10
View File
@@ -228,16 +228,16 @@ export type GeneralHelpers<NodeType extends Node = Node, EdgeType extends Edge =
nodeId: string;
handleId?: string | null;
}) => NodeConnection[];
// /**
// * Fits the view.
// *
// * @param options.padding - optional padding
// * @param options.includeHiddenNodes - optional includeHiddenNodes
// * @param options.minZoom - optional minZoom
// * @param options.maxZoom - optional maxZoom
// * @param options.duration - optional duration. If set, a transition will be applied
// * @param options.nodes - optional nodes to fit the view to
// */
/**
* Fits the view based on the passed params. By default it fits the view to all nodes.
*
* @param options.padding - optional padding
* @param options.nodes - optional nodes to fit the view to
* @param options.minZoom - optional minZoom
* @param options.maxZoom - optional maxZoom
* @param options.duration - optional duration. If set, a transition will be applied
* @param options.includeHiddenNodes - optional includeHiddenNodes
*/
fitView: FitView<NodeType>;
};
/**
+2 -2
View File
@@ -132,11 +132,11 @@ export type EdgeLookup<EdgeType extends EdgeBase = EdgeBase> = Map<string, EdgeT
export type EdgeToolbarBaseProps = {
/**
* The `x` position of the edge label.
* The `x` position of the edge toolbar.
*/
x: number;
/**
* The `y` position of the edge label.
* The `y` position of the edge toolbar.
*/
y: number;
/** If `true`, edge toolbar is visible even if edge is not selected.