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

fix: improve TSDoc comments for ViewportHelperFunctions and NodeToolbarProps

Browse Source
This commit is contained in:
Dimitri POSTOLOV
2025-04-01 20:49:08 +02:00
parent 245b6265a6
commit d4eb8d52d0
3 changed files with 22 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/react/src/additional-components/NodeToolbar/types.ts
+6 -5
View File
@@ -10,12 +10,12 @@ export type NodeToolbarProps = HTMLAttributes<HTMLDivElement> & {
* of nodes.
*/
nodeId?: string | string[];
/** If true, node toolbar is visible even if node is not selected */
/** If `true`, node toolbar is visible even if node is not selected. */
isVisible?: boolean;
/**
* Position of the toolbar relative to the node
* @example Position.TopLeft, Position.TopRight,
* Position.BottomLeft, Position.BottomRight
* Position of the toolbar relative to the node.
* @default Position.Top
* @example Position.TopLeft, Position.TopRight, Position.BottomLeft, Position.BottomRight
*/
position?: Position;
/**
@@ -24,7 +24,8 @@ export type NodeToolbarProps = HTMLAttributes<HTMLDivElement> & {
*/
offset?: number;
/**
* Align the toolbar relative to the node
* Align the toolbar relative to the node.
* @default "center"
* @example Align.Start, Align.Center, Align.End
*/
align?: Align;