added typedocs for plugins

2024-01-15 17:38:54 +01:00
parent e35e0348fe
commit 8c32b426f4
10 changed files with 151 additions and 0 deletions
@@ -1,9 +1,16 @@
 import type { PanelPosition } from '@xyflow/system';

 export type ControlsProps = {
+  /** position of the controls on the pane
+   * @example PanelPosition.TopLeft, PanelPosition.TopRight,
+   * PanelPosition.BottomLeft, PanelPosition.BottomRight
+   */
  position?: PanelPosition;
+  /** show button for zoom in/out */
  showZoom?: boolean;
+  /** show button for fit view */
  showFitView?: boolean;
+  /** show button for toggling interactivity */
  showLock?: boolean;
  buttonBgColor?: string;
  buttonBgColorHover?: string;