Merge pull request #5116 from dimaMachina/tsdoc-NodeToolbarProps

fix: improve TSDoc comments for `NodeToolbarProps`
This commit is contained in:
Moritz Klack
2025-03-26 09:03:56 +01:00
committed by GitHub
2 changed files with 13 additions and 2 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@xyflow/react': patch
---
fix: improve TSDoc comments for `NodeToolbarProps`
@@ -5,7 +5,10 @@ import type { Position, Align } from '@xyflow/system';
* @expand * @expand
*/ */
export type NodeToolbarProps = HTMLAttributes<HTMLDivElement> & { export type NodeToolbarProps = HTMLAttributes<HTMLDivElement> & {
/** Id of the node, or array of ids the toolbar should be displayed at */ /**
* By passing in an array of node id's you can render a single tooltip for a group or collection
* of nodes.
*/
nodeId?: string | string[]; 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; isVisible?: boolean;
@@ -15,7 +18,10 @@ export type NodeToolbarProps = HTMLAttributes<HTMLDivElement> & {
* Position.BottomLeft, Position.BottomRight * Position.BottomLeft, Position.BottomRight
*/ */
position?: Position; position?: Position;
/** Offset the toolbar from the node */ /**
* The space between the node and the toolbar, measured in pixels.
* @default 10
*/
offset?: number; offset?: number;
/** /**
* Align the toolbar relative to the node * Align the toolbar relative to the node