Merge pull request #5557 from xyflow/chore/tsdocs-adjustments
chore(tsdocs): adjustments
This commit is contained in:
@@ -228,16 +228,16 @@ export type GeneralHelpers<NodeType extends Node = Node, EdgeType extends Edge =
|
|||||||
nodeId: string;
|
nodeId: string;
|
||||||
handleId?: string | null;
|
handleId?: string | null;
|
||||||
}) => NodeConnection[];
|
}) => NodeConnection[];
|
||||||
// /**
|
/**
|
||||||
// * Fits the view.
|
* Fits the view based on the passed params. By default it fits the view to all nodes.
|
||||||
// *
|
*
|
||||||
// * @param options.padding - optional padding
|
* @param options.padding - optional padding
|
||||||
// * @param options.includeHiddenNodes - optional includeHiddenNodes
|
* @param options.nodes - optional nodes to fit the view to
|
||||||
// * @param options.minZoom - optional minZoom
|
* @param options.minZoom - optional minZoom
|
||||||
// * @param options.maxZoom - optional maxZoom
|
* @param options.maxZoom - optional maxZoom
|
||||||
// * @param options.duration - optional duration. If set, a transition will be applied
|
* @param options.duration - optional duration. If set, a transition will be applied
|
||||||
// * @param options.nodes - optional nodes to fit the view to
|
* @param options.includeHiddenNodes - optional includeHiddenNodes
|
||||||
// */
|
*/
|
||||||
fitView: FitView<NodeType>;
|
fitView: FitView<NodeType>;
|
||||||
};
|
};
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -132,11 +132,11 @@ export type EdgeLookup<EdgeType extends EdgeBase = EdgeBase> = Map<string, EdgeT
|
|||||||
|
|
||||||
export type EdgeToolbarBaseProps = {
|
export type EdgeToolbarBaseProps = {
|
||||||
/**
|
/**
|
||||||
* The `x` position of the edge label.
|
* The `x` position of the edge toolbar.
|
||||||
*/
|
*/
|
||||||
x: number;
|
x: number;
|
||||||
/**
|
/**
|
||||||
* The `y` position of the edge label.
|
* The `y` position of the edge toolbar.
|
||||||
*/
|
*/
|
||||||
y: number;
|
y: number;
|
||||||
/** If `true`, edge toolbar is visible even if edge is not selected.
|
/** If `true`, edge toolbar is visible even if edge is not selected.
|
||||||
|
|||||||
Reference in New Issue
Block a user