@xyflow/react 12.4.2 → 12.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (230) hide show
  1. package/dist/esm/additional-components/Background/Background.d.ts +53 -0
  2. package/dist/esm/additional-components/Background/Background.d.ts.map +1 -1
  3. package/dist/esm/additional-components/Background/types.d.ts +11 -1
  4. package/dist/esm/additional-components/Background/types.d.ts.map +1 -1
  5. package/dist/esm/additional-components/Controls/ControlButton.d.ts +23 -0
  6. package/dist/esm/additional-components/Controls/ControlButton.d.ts.map +1 -1
  7. package/dist/esm/additional-components/Controls/Controls.d.ts +21 -0
  8. package/dist/esm/additional-components/Controls/Controls.d.ts.map +1 -1
  9. package/dist/esm/additional-components/Controls/types.d.ts +8 -1
  10. package/dist/esm/additional-components/Controls/types.d.ts.map +1 -1
  11. package/dist/esm/additional-components/MiniMap/MiniMap.d.ts +20 -0
  12. package/dist/esm/additional-components/MiniMap/MiniMap.d.ts.map +1 -1
  13. package/dist/esm/additional-components/MiniMap/MiniMapNodes.d.ts.map +1 -1
  14. package/dist/esm/additional-components/MiniMap/types.d.ts +11 -1
  15. package/dist/esm/additional-components/MiniMap/types.d.ts.map +1 -1
  16. package/dist/esm/additional-components/NodeResizer/NodeResizeControl.d.ts +5 -0
  17. package/dist/esm/additional-components/NodeResizer/NodeResizeControl.d.ts.map +1 -1
  18. package/dist/esm/additional-components/NodeResizer/NodeResizer.d.ts +24 -0
  19. package/dist/esm/additional-components/NodeResizer/NodeResizer.d.ts.map +1 -1
  20. package/dist/esm/additional-components/NodeResizer/types.d.ts +15 -3
  21. package/dist/esm/additional-components/NodeResizer/types.d.ts.map +1 -1
  22. package/dist/esm/additional-components/NodeToolbar/NodeToolbar.d.ts +35 -0
  23. package/dist/esm/additional-components/NodeToolbar/NodeToolbar.d.ts.map +1 -1
  24. package/dist/esm/additional-components/NodeToolbar/types.d.ts +7 -2
  25. package/dist/esm/additional-components/NodeToolbar/types.d.ts.map +1 -1
  26. package/dist/esm/components/BatchProvider/index.d.ts.map +1 -1
  27. package/dist/esm/components/BatchProvider/useQueue.d.ts.map +1 -1
  28. package/dist/esm/components/ConnectionLine/index.d.ts +4 -4
  29. package/dist/esm/components/ConnectionLine/index.d.ts.map +1 -1
  30. package/dist/esm/components/EdgeLabelRenderer/index.d.ts +40 -0
  31. package/dist/esm/components/EdgeLabelRenderer/index.d.ts.map +1 -1
  32. package/dist/esm/components/EdgeWrapper/index.d.ts +1 -1
  33. package/dist/esm/components/EdgeWrapper/index.d.ts.map +1 -1
  34. package/dist/esm/components/Edges/BaseEdge.d.ts +27 -0
  35. package/dist/esm/components/Edges/BaseEdge.d.ts.map +1 -1
  36. package/dist/esm/components/Edges/EdgeText.d.ts +26 -0
  37. package/dist/esm/components/Edges/EdgeText.d.ts.map +1 -1
  38. package/dist/esm/components/Edges/SimpleBezierEdge.d.ts +5 -0
  39. package/dist/esm/components/Edges/SimpleBezierEdge.d.ts.map +1 -1
  40. package/dist/esm/components/Edges/index.d.ts.map +1 -1
  41. package/dist/esm/components/Handle/index.d.ts +32 -4
  42. package/dist/esm/components/Handle/index.d.ts.map +1 -1
  43. package/dist/esm/components/NodeWrapper/index.d.ts +1 -1
  44. package/dist/esm/components/NodeWrapper/index.d.ts.map +1 -1
  45. package/dist/esm/components/NodeWrapper/useNodeObserver.d.ts.map +1 -1
  46. package/dist/esm/components/NodeWrapper/utils.d.ts.map +1 -1
  47. package/dist/esm/components/Nodes/utils.d.ts.map +1 -1
  48. package/dist/esm/components/Panel/index.d.ts +32 -4
  49. package/dist/esm/components/Panel/index.d.ts.map +1 -1
  50. package/dist/esm/components/ReactFlowProvider/index.d.ts +34 -0
  51. package/dist/esm/components/ReactFlowProvider/index.d.ts.map +1 -1
  52. package/dist/esm/components/SelectionListener/index.d.ts +4 -4
  53. package/dist/esm/components/SelectionListener/index.d.ts.map +1 -1
  54. package/dist/esm/components/StoreUpdater/index.d.ts.map +1 -1
  55. package/dist/esm/components/ViewportPortal/index.d.ts +25 -0
  56. package/dist/esm/components/ViewportPortal/index.d.ts.map +1 -1
  57. package/dist/esm/container/EdgeRenderer/MarkerDefinitions.d.ts.map +1 -1
  58. package/dist/esm/container/NodeRenderer/index.d.ts.map +1 -1
  59. package/dist/esm/container/Pane/index.d.ts.map +1 -1
  60. package/dist/esm/container/ReactFlow/Wrapper.d.ts.map +1 -1
  61. package/dist/esm/container/ReactFlow/index.d.ts +21 -1
  62. package/dist/esm/container/ReactFlow/index.d.ts.map +1 -1
  63. package/dist/esm/contexts/NodeIdContext.d.ts +28 -0
  64. package/dist/esm/contexts/NodeIdContext.d.ts.map +1 -1
  65. package/dist/esm/hooks/useConnection.d.ts +20 -1
  66. package/dist/esm/hooks/useConnection.d.ts.map +1 -1
  67. package/dist/esm/hooks/useEdges.d.ts +13 -1
  68. package/dist/esm/hooks/useEdges.d.ts.map +1 -1
  69. package/dist/esm/hooks/useInternalNode.d.ts +21 -1
  70. package/dist/esm/hooks/useInternalNode.d.ts.map +1 -1
  71. package/dist/esm/hooks/useKeyPress.d.ts +19 -1
  72. package/dist/esm/hooks/useKeyPress.d.ts.map +1 -1
  73. package/dist/esm/hooks/useMoveSelectedNodes.d.ts.map +1 -1
  74. package/dist/esm/hooks/useNodeConnections.d.ts +17 -1
  75. package/dist/esm/hooks/useNodeConnections.d.ts.map +1 -1
  76. package/dist/esm/hooks/useNodes.d.ts +14 -1
  77. package/dist/esm/hooks/useNodes.d.ts.map +1 -1
  78. package/dist/esm/hooks/useNodesData.d.ts +14 -2
  79. package/dist/esm/hooks/useNodesData.d.ts.map +1 -1
  80. package/dist/esm/hooks/useNodesEdgesState.d.ts +62 -2
  81. package/dist/esm/hooks/useNodesEdgesState.d.ts.map +1 -1
  82. package/dist/esm/hooks/useNodesInitialized.d.ts +27 -1
  83. package/dist/esm/hooks/useNodesInitialized.d.ts.map +1 -1
  84. package/dist/esm/hooks/useOnSelectionChange.d.ts +37 -5
  85. package/dist/esm/hooks/useOnSelectionChange.d.ts.map +1 -1
  86. package/dist/esm/hooks/useOnViewportChange.d.ts +19 -1
  87. package/dist/esm/hooks/useOnViewportChange.d.ts.map +1 -1
  88. package/dist/esm/hooks/useReactFlow.d.ts +24 -1
  89. package/dist/esm/hooks/useReactFlow.d.ts.map +1 -1
  90. package/dist/esm/hooks/useStore.d.ts +23 -2
  91. package/dist/esm/hooks/useStore.d.ts.map +1 -1
  92. package/dist/esm/hooks/useUpdateNodeInternals.d.ts +39 -1
  93. package/dist/esm/hooks/useUpdateNodeInternals.d.ts.map +1 -1
  94. package/dist/esm/hooks/useViewport.d.ts +24 -1
  95. package/dist/esm/hooks/useViewport.d.ts.map +1 -1
  96. package/dist/esm/hooks/useViewportHelper.d.ts.map +1 -1
  97. package/dist/esm/index.js +1107 -198
  98. package/dist/esm/index.mjs +1107 -198
  99. package/dist/esm/store/index.d.ts.map +1 -1
  100. package/dist/esm/types/component-props.d.ts +112 -57
  101. package/dist/esm/types/component-props.d.ts.map +1 -1
  102. package/dist/esm/types/edges.d.ts +27 -2
  103. package/dist/esm/types/edges.d.ts.map +1 -1
  104. package/dist/esm/types/general.d.ts +48 -7
  105. package/dist/esm/types/general.d.ts.map +1 -1
  106. package/dist/esm/types/instance.d.ts +11 -1
  107. package/dist/esm/types/instance.d.ts.map +1 -1
  108. package/dist/esm/types/nodes.d.ts +46 -4
  109. package/dist/esm/types/nodes.d.ts.map +1 -1
  110. package/dist/esm/types/store.d.ts +2 -2
  111. package/dist/esm/types/store.d.ts.map +1 -1
  112. package/dist/esm/utils/changes.d.ts +45 -23
  113. package/dist/esm/utils/changes.d.ts.map +1 -1
  114. package/dist/esm/utils/general.d.ts +27 -3
  115. package/dist/esm/utils/general.d.ts.map +1 -1
  116. package/dist/umd/additional-components/Background/Background.d.ts +53 -0
  117. package/dist/umd/additional-components/Background/Background.d.ts.map +1 -1
  118. package/dist/umd/additional-components/Background/types.d.ts +11 -1
  119. package/dist/umd/additional-components/Background/types.d.ts.map +1 -1
  120. package/dist/umd/additional-components/Controls/ControlButton.d.ts +23 -0
  121. package/dist/umd/additional-components/Controls/ControlButton.d.ts.map +1 -1
  122. package/dist/umd/additional-components/Controls/Controls.d.ts +21 -0
  123. package/dist/umd/additional-components/Controls/Controls.d.ts.map +1 -1
  124. package/dist/umd/additional-components/Controls/types.d.ts +8 -1
  125. package/dist/umd/additional-components/Controls/types.d.ts.map +1 -1
  126. package/dist/umd/additional-components/MiniMap/MiniMap.d.ts +20 -0
  127. package/dist/umd/additional-components/MiniMap/MiniMap.d.ts.map +1 -1
  128. package/dist/umd/additional-components/MiniMap/MiniMapNodes.d.ts.map +1 -1
  129. package/dist/umd/additional-components/MiniMap/types.d.ts +11 -1
  130. package/dist/umd/additional-components/MiniMap/types.d.ts.map +1 -1
  131. package/dist/umd/additional-components/NodeResizer/NodeResizeControl.d.ts +5 -0
  132. package/dist/umd/additional-components/NodeResizer/NodeResizeControl.d.ts.map +1 -1
  133. package/dist/umd/additional-components/NodeResizer/NodeResizer.d.ts +24 -0
  134. package/dist/umd/additional-components/NodeResizer/NodeResizer.d.ts.map +1 -1
  135. package/dist/umd/additional-components/NodeResizer/types.d.ts +15 -3
  136. package/dist/umd/additional-components/NodeResizer/types.d.ts.map +1 -1
  137. package/dist/umd/additional-components/NodeToolbar/NodeToolbar.d.ts +35 -0
  138. package/dist/umd/additional-components/NodeToolbar/NodeToolbar.d.ts.map +1 -1
  139. package/dist/umd/additional-components/NodeToolbar/types.d.ts +7 -2
  140. package/dist/umd/additional-components/NodeToolbar/types.d.ts.map +1 -1
  141. package/dist/umd/components/BatchProvider/index.d.ts.map +1 -1
  142. package/dist/umd/components/BatchProvider/useQueue.d.ts.map +1 -1
  143. package/dist/umd/components/ConnectionLine/index.d.ts +4 -4
  144. package/dist/umd/components/ConnectionLine/index.d.ts.map +1 -1
  145. package/dist/umd/components/EdgeLabelRenderer/index.d.ts +40 -0
  146. package/dist/umd/components/EdgeLabelRenderer/index.d.ts.map +1 -1
  147. package/dist/umd/components/EdgeWrapper/index.d.ts +1 -1
  148. package/dist/umd/components/EdgeWrapper/index.d.ts.map +1 -1
  149. package/dist/umd/components/Edges/BaseEdge.d.ts +27 -0
  150. package/dist/umd/components/Edges/BaseEdge.d.ts.map +1 -1
  151. package/dist/umd/components/Edges/EdgeText.d.ts +26 -0
  152. package/dist/umd/components/Edges/EdgeText.d.ts.map +1 -1
  153. package/dist/umd/components/Edges/SimpleBezierEdge.d.ts +5 -0
  154. package/dist/umd/components/Edges/SimpleBezierEdge.d.ts.map +1 -1
  155. package/dist/umd/components/Edges/index.d.ts.map +1 -1
  156. package/dist/umd/components/Handle/index.d.ts +32 -4
  157. package/dist/umd/components/Handle/index.d.ts.map +1 -1
  158. package/dist/umd/components/NodeWrapper/index.d.ts +1 -1
  159. package/dist/umd/components/NodeWrapper/index.d.ts.map +1 -1
  160. package/dist/umd/components/NodeWrapper/useNodeObserver.d.ts.map +1 -1
  161. package/dist/umd/components/NodeWrapper/utils.d.ts.map +1 -1
  162. package/dist/umd/components/Nodes/utils.d.ts.map +1 -1
  163. package/dist/umd/components/Panel/index.d.ts +32 -4
  164. package/dist/umd/components/Panel/index.d.ts.map +1 -1
  165. package/dist/umd/components/ReactFlowProvider/index.d.ts +34 -0
  166. package/dist/umd/components/ReactFlowProvider/index.d.ts.map +1 -1
  167. package/dist/umd/components/SelectionListener/index.d.ts +4 -4
  168. package/dist/umd/components/SelectionListener/index.d.ts.map +1 -1
  169. package/dist/umd/components/StoreUpdater/index.d.ts.map +1 -1
  170. package/dist/umd/components/ViewportPortal/index.d.ts +25 -0
  171. package/dist/umd/components/ViewportPortal/index.d.ts.map +1 -1
  172. package/dist/umd/container/EdgeRenderer/MarkerDefinitions.d.ts.map +1 -1
  173. package/dist/umd/container/NodeRenderer/index.d.ts.map +1 -1
  174. package/dist/umd/container/Pane/index.d.ts.map +1 -1
  175. package/dist/umd/container/ReactFlow/Wrapper.d.ts.map +1 -1
  176. package/dist/umd/container/ReactFlow/index.d.ts +21 -1
  177. package/dist/umd/container/ReactFlow/index.d.ts.map +1 -1
  178. package/dist/umd/contexts/NodeIdContext.d.ts +28 -0
  179. package/dist/umd/contexts/NodeIdContext.d.ts.map +1 -1
  180. package/dist/umd/hooks/useConnection.d.ts +20 -1
  181. package/dist/umd/hooks/useConnection.d.ts.map +1 -1
  182. package/dist/umd/hooks/useEdges.d.ts +13 -1
  183. package/dist/umd/hooks/useEdges.d.ts.map +1 -1
  184. package/dist/umd/hooks/useInternalNode.d.ts +21 -1
  185. package/dist/umd/hooks/useInternalNode.d.ts.map +1 -1
  186. package/dist/umd/hooks/useKeyPress.d.ts +19 -1
  187. package/dist/umd/hooks/useKeyPress.d.ts.map +1 -1
  188. package/dist/umd/hooks/useMoveSelectedNodes.d.ts.map +1 -1
  189. package/dist/umd/hooks/useNodeConnections.d.ts +17 -1
  190. package/dist/umd/hooks/useNodeConnections.d.ts.map +1 -1
  191. package/dist/umd/hooks/useNodes.d.ts +14 -1
  192. package/dist/umd/hooks/useNodes.d.ts.map +1 -1
  193. package/dist/umd/hooks/useNodesData.d.ts +14 -2
  194. package/dist/umd/hooks/useNodesData.d.ts.map +1 -1
  195. package/dist/umd/hooks/useNodesEdgesState.d.ts +62 -2
  196. package/dist/umd/hooks/useNodesEdgesState.d.ts.map +1 -1
  197. package/dist/umd/hooks/useNodesInitialized.d.ts +27 -1
  198. package/dist/umd/hooks/useNodesInitialized.d.ts.map +1 -1
  199. package/dist/umd/hooks/useOnSelectionChange.d.ts +37 -5
  200. package/dist/umd/hooks/useOnSelectionChange.d.ts.map +1 -1
  201. package/dist/umd/hooks/useOnViewportChange.d.ts +19 -1
  202. package/dist/umd/hooks/useOnViewportChange.d.ts.map +1 -1
  203. package/dist/umd/hooks/useReactFlow.d.ts +24 -1
  204. package/dist/umd/hooks/useReactFlow.d.ts.map +1 -1
  205. package/dist/umd/hooks/useStore.d.ts +23 -2
  206. package/dist/umd/hooks/useStore.d.ts.map +1 -1
  207. package/dist/umd/hooks/useUpdateNodeInternals.d.ts +39 -1
  208. package/dist/umd/hooks/useUpdateNodeInternals.d.ts.map +1 -1
  209. package/dist/umd/hooks/useViewport.d.ts +24 -1
  210. package/dist/umd/hooks/useViewport.d.ts.map +1 -1
  211. package/dist/umd/hooks/useViewportHelper.d.ts.map +1 -1
  212. package/dist/umd/index.js +2 -2
  213. package/dist/umd/store/index.d.ts.map +1 -1
  214. package/dist/umd/types/component-props.d.ts +112 -57
  215. package/dist/umd/types/component-props.d.ts.map +1 -1
  216. package/dist/umd/types/edges.d.ts +27 -2
  217. package/dist/umd/types/edges.d.ts.map +1 -1
  218. package/dist/umd/types/general.d.ts +48 -7
  219. package/dist/umd/types/general.d.ts.map +1 -1
  220. package/dist/umd/types/instance.d.ts +11 -1
  221. package/dist/umd/types/instance.d.ts.map +1 -1
  222. package/dist/umd/types/nodes.d.ts +46 -4
  223. package/dist/umd/types/nodes.d.ts.map +1 -1
  224. package/dist/umd/types/store.d.ts +2 -2
  225. package/dist/umd/types/store.d.ts.map +1 -1
  226. package/dist/umd/utils/changes.d.ts +45 -23
  227. package/dist/umd/utils/changes.d.ts.map +1 -1
  228. package/dist/umd/utils/general.d.ts +27 -3
  229. package/dist/umd/utils/general.d.ts.map +1 -1
  230. package/package.json +4 -3
@@ -4,6 +4,59 @@ declare function BackgroundComponent({ id, variant, gap, size, lineWidth, offset
4
4
  declare namespace BackgroundComponent {
5
5
  var displayName: string;
6
6
  }
7
+ /**
8
+ * The `<Background />` component makes it convenient to render different types of backgrounds common in node-based UIs. It comes with three variants: lines, dots and cross.
9
+ *
10
+ * @example
11
+ *
12
+ * A simple example of how to use the Background component.
13
+ *
14
+ * ```tsx
15
+ * import { useState } from 'react';
16
+ * import { ReactFlow, Background, BackgroundVariant } from '@xyflow/react';
17
+ *
18
+ * export default function Flow() {
19
+ * return (
20
+ * <ReactFlow defaultNodes={[...]} defaultEdges={[...]}>
21
+ * <Background color="#ccc" variant={BackgroundVariant.Dots} />
22
+ * </ReactFlow>
23
+ * );
24
+ * }
25
+ * ```
26
+ *
27
+ * @example
28
+ *
29
+ * In this example you can see how to combine multiple backgrounds
30
+ *
31
+ * ```tsx
32
+ * import { ReactFlow, Background, BackgroundVariant } from '@xyflow/react';
33
+ * import '@xyflow/react/dist/style.css';
34
+ *
35
+ * export default function Flow() {
36
+ * return (
37
+ * <ReactFlow defaultNodes={[...]} defaultEdges={[...]}>
38
+ * <Background
39
+ * id="1"
40
+ * gap={10}
41
+ * color="#f1f1f1"
42
+ * variant={BackgroundVariant.Lines}
43
+ * />
44
+ * <Background
45
+ * id="2"
46
+ * gap={100}
47
+ * color="#ccc"
48
+ * variant={BackgroundVariant.Lines}
49
+ * />
50
+ * </ReactFlow>
51
+ * );
52
+ * }
53
+ * ```
54
+ *
55
+ * @remarks
56
+ *
57
+ * When combining multiple <Background /> components it’s important to give each of them a unique id prop!
58
+ *
59
+ */
7
60
  export declare const Background: import("react").MemoExoticComponent<typeof BackgroundComponent>;
8
61
  export {};
9
62
  //# sourceMappingURL=Background.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Background.d.ts","sourceRoot":"","sources":["../../../src/additional-components/Background/Background.tsx"],"names":[],"mappings":";AAOA,OAAO,EAAE,KAAK,eAAe,EAAqB,MAAM,SAAS,CAAC;AAWlE,iBAAS,mBAAmB,CAAC,EAC3B,EAAE,EACF,OAAgC,EAEhC,GAAQ,EAER,IAAI,EACJ,SAAa,EACb,MAAU,EACV,KAAK,EACL,OAAO,EACP,KAAK,EACL,SAAS,EACT,gBAAgB,GACjB,EAAE,eAAe,2CAwDjB;kBAtEQ,mBAAmB;;;AA0E5B,eAAO,MAAM,UAAU,iEAA4B,CAAC"}
1
+ {"version":3,"file":"Background.d.ts","sourceRoot":"","sources":["../../../src/additional-components/Background/Background.tsx"],"names":[],"mappings":";AAOA,OAAO,EAAE,KAAK,eAAe,EAAqB,MAAM,SAAS,CAAC;AAWlE,iBAAS,mBAAmB,CAAC,EAC3B,EAAE,EACF,OAAgC,EAEhC,GAAQ,EAER,IAAI,EACJ,SAAa,EACb,MAAU,EACV,KAAK,EACL,OAAO,EACP,KAAK,EACL,SAAS,EACT,gBAAgB,GACjB,EAAE,eAAe,2CAwDjB;kBAtEQ,mBAAmB;;;AA0E5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,eAAO,MAAM,UAAU,iEAA4B,CAAC"}
@@ -1,9 +1,18 @@
1
1
  import { CSSProperties } from 'react';
2
+ /**
3
+ * The three variants are exported as an enum for convenience. You can either import
4
+ * the enum and use it like `BackgroundVariant.Lines` or you can use the raw string
5
+ * value directly.
6
+ * @public
7
+ */
2
8
  export declare enum BackgroundVariant {
3
9
  Lines = "lines",
4
10
  Dots = "dots",
5
11
  Cross = "cross"
6
12
  }
13
+ /**
14
+ * @expand
15
+ */
7
16
  export type BackgroundProps = {
8
17
  id?: string;
9
18
  /** Color of the pattern */
@@ -22,7 +31,8 @@ export type BackgroundProps = {
22
31
  offset?: number | [number, number];
23
32
  /** Line width of the Line pattern */
24
33
  lineWidth?: number;
25
- /** Variant of the pattern
34
+ /**
35
+ * Variant of the pattern
26
36
  * @example BackgroundVariant.Lines, BackgroundVariant.Dots, BackgroundVariant.Cross
27
37
  * 'lines', 'dots', 'cross'
28
38
  */
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/additional-components/Background/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAEtC,oBAAY,iBAAiB;IAC3B,KAAK,UAAU;IACf,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,2BAA2B;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mCAAmC;IACnC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,6CAA6C;IAC7C,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,uCAAuC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,qCAAqC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,qCAAqC;IACrC,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/additional-components/Background/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAEtC;;;;;GAKG;AACH,oBAAY,iBAAiB;IAC3B,KAAK,UAAU;IACf,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,2BAA2B;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mCAAmC;IACnC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,6CAA6C;IAC7C,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,uCAAuC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,qCAAqC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,qCAAqC;IACrC,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC"}
@@ -1,3 +1,26 @@
1
1
  import type { ControlButtonProps } from './types';
2
+ /**
3
+ * You can add buttons to the control panel by using the `<ControlButton />` component
4
+ * and pass it as a child to the [`<Controls />`](/api-reference/components/controls) component.
5
+ *
6
+ * @public
7
+ * @example
8
+ *```jsx
9
+ *import { MagicWand } from '@radix-ui/react-icons'
10
+ *import { ReactFlow, Controls, ControlButton } from '@xyflow/react'
11
+ *
12
+ *export default function Flow() {
13
+ * return (
14
+ * <ReactFlow nodes={[...]} edges={[...]}>
15
+ * <Controls>
16
+ * <ControlButton onClick={() => alert('Something magical just happened. ✨')}>
17
+ * <MagicWand />
18
+ * </ControlButton>
19
+ * </Controls>
20
+ * </ReactFlow>
21
+ * )
22
+ *}
23
+ *```
24
+ */
2
25
  export declare function ControlButton({ children, className, ...rest }: ControlButtonProps): import("react/jsx-runtime").JSX.Element;
3
26
  //# sourceMappingURL=ControlButton.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ControlButton.d.ts","sourceRoot":"","sources":["../../../src/additional-components/Controls/ControlButton.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElD,wBAAgB,aAAa,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,EAAE,kBAAkB,2CAMjF"}
1
+ {"version":3,"file":"ControlButton.d.ts","sourceRoot":"","sources":["../../../src/additional-components/Controls/ControlButton.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,aAAa,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,EAAE,kBAAkB,2CAMjF"}
@@ -4,6 +4,27 @@ declare function ControlsComponent({ style, showZoom, showFitView, showInteracti
4
4
  declare namespace ControlsComponent {
5
5
  var displayName: string;
6
6
  }
7
+ /**
8
+ * The `<Controls />` component renders a small panel that contains convenient
9
+ * buttons to zoom in, zoom out, fit the view, and lock the viewport.
10
+ *
11
+ * @public
12
+ * @example
13
+ *```tsx
14
+ *import { ReactFlow, Controls } from '@xyflow/react'
15
+ *
16
+ *export default function Flow() {
17
+ * return (
18
+ * <ReactFlow nodes={[...]} edges={[...]}>
19
+ * <Controls />
20
+ * </ReactFlow>
21
+ * )
22
+ *}
23
+ *```
24
+ *
25
+ * @remarks To extend or customise the controls, you can use the [`<ControlButton />`](/api-reference/components/control-button) component
26
+ *
27
+ */
7
28
  export declare const Controls: import("react").MemoExoticComponent<typeof ControlsComponent>;
8
29
  export {};
9
30
  //# sourceMappingURL=Controls.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Controls.d.ts","sourceRoot":"","sources":["../../../src/additional-components/Controls/Controls.tsx"],"names":[],"mappings":";AAeA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAQ5C,iBAAS,iBAAiB,CAAC,EACzB,KAAK,EACL,QAAe,EACf,WAAkB,EAClB,eAAsB,EACtB,cAAc,EACd,QAAQ,EACR,SAAS,EACT,SAAS,EACT,mBAAmB,EACnB,SAAS,EACT,QAAQ,EACR,QAAwB,EACxB,WAAwB,EACxB,YAAY,EAAE,SAAiC,GAChD,EAAE,YAAY,2CAqFd;kBApGQ,iBAAiB;;;AAwG1B,eAAO,MAAM,QAAQ,+DAA0B,CAAC"}
1
+ {"version":3,"file":"Controls.d.ts","sourceRoot":"","sources":["../../../src/additional-components/Controls/Controls.tsx"],"names":[],"mappings":";AAeA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAQ5C,iBAAS,iBAAiB,CAAC,EACzB,KAAK,EACL,QAAe,EACf,WAAkB,EAClB,eAAsB,EACtB,cAAc,EACd,QAAQ,EACR,SAAS,EACT,SAAS,EACT,mBAAmB,EACnB,SAAS,EACT,QAAQ,EACR,QAAwB,EACxB,WAAwB,EACxB,YAAY,EAAE,SAAiC,GAChD,EAAE,YAAY,2CAqFd;kBApGQ,iBAAiB;;;AAwG1B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,QAAQ,+DAA0B,CAAC"}
@@ -1,6 +1,9 @@
1
1
  import type { ButtonHTMLAttributes, ReactNode } from 'react';
2
2
  import type { PanelPosition } from '@xyflow/system';
3
3
  import type { FitViewOptions } from '../../types';
4
+ /**
5
+ * @expand
6
+ */
4
7
  export type ControlProps = {
5
8
  /** Show button for zoom in/out */
6
9
  showZoom?: boolean;
@@ -18,7 +21,8 @@ export type ControlProps = {
18
21
  onFitView?: () => void;
19
22
  /** Callback when interactivity is toggled */
20
23
  onInteractiveChange?: (interactiveStatus: boolean) => void;
21
- /** Position of the controls on the pane
24
+ /**
25
+ * Position of the controls on the pane
22
26
  * @example PanelPosition.TopLeft, PanelPosition.TopRight,
23
27
  * PanelPosition.BottomLeft, PanelPosition.BottomRight
24
28
  */
@@ -31,5 +35,8 @@ export type ControlProps = {
31
35
  'aria-label'?: string;
32
36
  orientation?: 'horizontal' | 'vertical';
33
37
  };
38
+ /**
39
+ * @expand
40
+ */
34
41
  export type ControlButtonProps = ButtonHTMLAttributes<HTMLButtonElement>;
35
42
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/additional-components/Controls/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAC7D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD,MAAM,MAAM,YAAY,GAAG;IACzB,kCAAkC;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,+BAA+B;IAC/B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,6CAA6C;IAC7C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,yDAAyD;IACzD,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,6CAA6C;IAC7C,mBAAmB,CAAC,EAAE,CAAC,iBAAiB,EAAE,OAAO,KAAK,IAAI,CAAC;IAC3D;;;OAGG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,iCAAiC;IACjC,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IAC5B,qCAAqC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC;CACzC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/additional-components/Controls/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAC7D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,kCAAkC;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,+BAA+B;IAC/B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,6CAA6C;IAC7C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,yDAAyD;IACzD,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;IACvB,6CAA6C;IAC7C,mBAAmB,CAAC,EAAE,CAAC,iBAAiB,EAAE,OAAO,KAAK,IAAI,CAAC;IAC3D;;;;OAIG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,iCAAiC;IACjC,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IAC5B,qCAAqC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,CAAC"}
@@ -4,6 +4,26 @@ declare function MiniMapComponent<NodeType extends Node = Node>({ style, classNa
4
4
  declare namespace MiniMapComponent {
5
5
  var displayName: string;
6
6
  }
7
+ /**
8
+ * The `<MiniMap />` component can be used to render an overview of your flow. It
9
+ * renders each node as an SVG element and visualizes where the current viewport is
10
+ * in relation to the rest of the flow.
11
+ *
12
+ * @public
13
+ * @example
14
+ *
15
+ * ```jsx
16
+ *import { ReactFlow, MiniMap } from '@xyflow/react';
17
+ *
18
+ *export default function Flow() {
19
+ * return (
20
+ * <ReactFlow nodes={[...]]} edges={[...]]}>
21
+ * <MiniMap nodeStrokeWidth={3} />
22
+ * </ReactFlow>
23
+ * );
24
+ *}
25
+ *```
26
+ */
7
27
  export declare const MiniMap: typeof MiniMapComponent;
8
28
  export {};
9
29
  //# sourceMappingURL=MiniMap.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"MiniMap.d.ts","sourceRoot":"","sources":["../../../src/additional-components/MiniMap/MiniMap.tsx"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAkB,IAAI,EAAE,MAAM,aAAa,CAAC;AAGxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AA0B5C,iBAAS,gBAAgB,CAAC,QAAQ,SAAS,IAAI,GAAG,IAAI,EAAE,EACtD,KAAK,EACL,SAAS,EACT,eAAe,EACf,SAAS,EACT,aAAkB,EAClB,gBAAoB,EACpB,eAAe,EAGf,aAAa,EACb,OAAO,EACP,SAAS,EACT,eAAe,EACf,eAAe,EACf,QAAyB,EACzB,OAAO,EACP,WAAW,EACX,QAAgB,EAChB,QAAgB,EAChB,SAAiC,EACjC,UAAU,EACV,QAAa,EACb,WAAe,GAChB,EAAE,YAAY,CAAC,QAAQ,CAAC,2CAgHxB;kBAxIQ,gBAAgB;;;AA4IzB,eAAO,MAAM,OAAO,yBAAoD,CAAC"}
1
+ {"version":3,"file":"MiniMap.d.ts","sourceRoot":"","sources":["../../../src/additional-components/MiniMap/MiniMap.tsx"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAkB,IAAI,EAAE,MAAM,aAAa,CAAC;AAGxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AA0B5C,iBAAS,gBAAgB,CAAC,QAAQ,SAAS,IAAI,GAAG,IAAI,EAAE,EACtD,KAAK,EACL,SAAS,EACT,eAAe,EACf,SAAS,EACT,aAAkB,EAClB,gBAAoB,EACpB,eAAe,EAKf,aAAa,EACb,OAAO,EACP,SAAS,EACT,eAAe,EACf,eAAe,EACf,QAAyB,EACzB,OAAO,EACP,WAAW,EACX,QAAgB,EAChB,QAAgB,EAChB,SAAiC,EACjC,UAAU,EACV,QAAa,EACb,WAAe,GAChB,EAAE,YAAY,CAAC,QAAQ,CAAC,2CAgHxB;kBA1IQ,gBAAgB;;;AA8IzB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,OAAO,yBAAoD,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"MiniMapNodes.d.ts","sourceRoot":"","sources":["../../../src/additional-components/MiniMap/MiniMapNodes.tsx"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAkB,IAAI,EAAgB,MAAM,aAAa,CAAC;AACtE,OAAO,KAAK,EAAE,YAAY,IAAI,iBAAiB,EAA6C,MAAM,SAAS,CAAC;AAQ5G,iBAAS,YAAY,CAAC,QAAQ,SAAS,IAAI,EAAE,EAC3C,eAAe,EACf,SAAS,EACT,aAAkB,EAClB,gBAAoB,EACpB,eAAe,EAGf,aAAa,EAAE,aAA2B,EAC1C,OAAO,GACR,EAAE,iBAAiB,CAAC,QAAQ,CAAC,2CA+B7B;;AA+DD,wBAAyD"}
1
+ {"version":3,"file":"MiniMapNodes.d.ts","sourceRoot":"","sources":["../../../src/additional-components/MiniMap/MiniMapNodes.tsx"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAkB,IAAI,EAAgB,MAAM,aAAa,CAAC;AACtE,OAAO,KAAK,EAAE,YAAY,IAAI,iBAAiB,EAA6C,MAAM,SAAS,CAAC;AAQ5G,iBAAS,YAAY,CAAC,QAAQ,SAAS,IAAI,EAAE,EAC3C,eAAe,EACf,SAAS,EACT,aAAkB,EAClB,gBAAoB,EACpB,eAAe,EAKf,aAAa,EAAE,aAA2B,EAC1C,OAAO,GACR,EAAE,iBAAiB,CAAC,QAAQ,CAAC,2CAiC7B;;AA+DD,wBAAyD"}
@@ -2,6 +2,9 @@ import type { ComponentType, CSSProperties, HTMLAttributes, MouseEvent } from 'r
2
2
  import type { PanelPosition, XYPosition } from '@xyflow/system';
3
3
  import type { Node } from '../../types';
4
4
  export type GetMiniMapNodeAttribute<NodeType extends Node = Node> = (node: NodeType) => string;
5
+ /**
6
+ * @expand
7
+ */
5
8
  export type MiniMapProps<NodeType extends Node = Node> = Omit<HTMLAttributes<SVGSVGElement>, 'onClick'> & {
6
9
  /** Color of nodes on minimap */
7
10
  nodeColor?: string | GetMiniMapNodeAttribute<NodeType>;
@@ -23,7 +26,8 @@ export type MiniMapProps<NodeType extends Node = Node> = Omit<HTMLAttributes<SVG
23
26
  maskStrokeColor?: string;
24
27
  /** Stroke width of mask representing viewport */
25
28
  maskStrokeWidth?: number;
26
- /** Position of minimap on pane
29
+ /**
30
+ * Position of minimap on pane
27
31
  * @example PanelPosition.TopLeft, PanelPosition.TopRight,
28
32
  * PanelPosition.BottomLeft, PanelPosition.BottomRight
29
33
  */
@@ -48,6 +52,12 @@ export type MiniMapProps<NodeType extends Node = Node> = Omit<HTMLAttributes<SVG
48
52
  export type MiniMapNodes<NodeType extends Node = Node> = Pick<MiniMapProps<NodeType>, 'nodeColor' | 'nodeStrokeColor' | 'nodeClassName' | 'nodeBorderRadius' | 'nodeStrokeWidth' | 'nodeComponent'> & {
49
53
  onClick?: (event: MouseEvent, nodeId: string) => void;
50
54
  };
55
+ /**
56
+ * The props that are passed to the MiniMapNode component
57
+ *
58
+ * @public
59
+ * @expand
60
+ */
51
61
  export type MiniMapNodeProps = {
52
62
  id: string;
53
63
  x: number;
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/additional-components/MiniMap/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEhE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,MAAM,uBAAuB,CAAC,QAAQ,SAAS,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,QAAQ,KAAK,MAAM,CAAC;AAE/F,MAAM,MAAM,YAAY,CAAC,QAAQ,SAAS,IAAI,GAAG,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC,GAAG;IACxG,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,GAAG,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IACvD,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,GAAG,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAC7D,4CAA4C;IAC5C,aAAa,CAAC,EAAE,MAAM,GAAG,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAC3D,wCAAwC;IACxC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gDAAgD;IAChD,aAAa,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAChD,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iDAAiD;IACjD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,4CAA4C;IAC5C,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,KAAK,IAAI,CAAC;IAC5D,sDAAsD;IACtD,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC1D,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,+BAA+B;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,yDAAyD;IACzD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6DAA6D;IAC7D,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,QAAQ,SAAS,IAAI,GAAG,IAAI,IAAI,IAAI,CAC3D,YAAY,CAAC,QAAQ,CAAC,EACtB,WAAW,GAAG,iBAAiB,GAAG,eAAe,GAAG,kBAAkB,GAAG,iBAAiB,GAAG,eAAe,CAC7G,GAAG;IACF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CACnD,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/additional-components/MiniMap/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACtF,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEhE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,MAAM,uBAAuB,CAAC,QAAQ,SAAS,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,QAAQ,KAAK,MAAM,CAAC;AAE/F;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,QAAQ,SAAS,IAAI,GAAG,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC,GAAG;IACxG,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,GAAG,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IACvD,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,GAAG,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAC7D,4CAA4C;IAC5C,aAAa,CAAC,EAAE,MAAM,GAAG,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAC3D,wCAAwC;IACxC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gDAAgD;IAChD,aAAa,CAAC,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAChD,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iDAAiD;IACjD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,4CAA4C;IAC5C,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,KAAK,IAAI,CAAC;IAC5D,sDAAsD;IACtD,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IAC1D,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,+BAA+B;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,yDAAyD;IACzD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6DAA6D;IAC7D,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,QAAQ,SAAS,IAAI,GAAG,IAAI,IAAI,IAAI,CAC3D,YAAY,CAAC,QAAQ,CAAC,EACtB,WAAW,GAAG,iBAAiB,GAAG,eAAe,GAAG,kBAAkB,GAAG,iBAAiB,GAAG,eAAe,CAC7G,GAAG;IACF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CACvD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CACnD,CAAC"}
@@ -2,6 +2,11 @@
2
2
  import type { ResizeControlProps, ResizeControlLineProps } from './types';
3
3
  declare function ResizeControl({ nodeId, position, variant, className, style, children, color, minWidth, minHeight, maxWidth, maxHeight, keepAspectRatio, shouldResize, onResizeStart, onResize, onResizeEnd, }: ResizeControlProps): import("react/jsx-runtime").JSX.Element;
4
4
  export declare function ResizeControlLine(props: ResizeControlLineProps): import("react/jsx-runtime").JSX.Element;
5
+ /**
6
+ * To create your own resizing UI, you can use the `NodeResizeControl` component where you can pass children (such as icons).
7
+ * @public
8
+ *
9
+ */
5
10
  export declare const NodeResizeControl: import("react").MemoExoticComponent<typeof ResizeControl>;
6
11
  export {};
7
12
  //# sourceMappingURL=NodeResizeControl.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"NodeResizeControl.d.ts","sourceRoot":"","sources":["../../../src/additional-components/NodeResizer/NodeResizeControl.tsx"],"names":[],"mappings":";AAmBA,OAAO,KAAK,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAE1E,iBAAS,aAAa,CAAC,EACrB,MAAM,EACN,QAAQ,EACR,OAAqC,EACrC,SAAS,EACT,KAAU,EACV,QAAQ,EACR,KAAK,EACL,QAAa,EACb,SAAc,EACd,QAA2B,EAC3B,SAA4B,EAC5B,eAAuB,EACvB,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,WAAW,GACZ,EAAE,kBAAkB,2CA+JpB;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,2CAE9D;AAED,eAAO,MAAM,iBAAiB,2DAAsB,CAAC"}
1
+ {"version":3,"file":"NodeResizeControl.d.ts","sourceRoot":"","sources":["../../../src/additional-components/NodeResizer/NodeResizeControl.tsx"],"names":[],"mappings":";AAmBA,OAAO,KAAK,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAE1E,iBAAS,aAAa,CAAC,EACrB,MAAM,EACN,QAAQ,EACR,OAAqC,EACrC,SAAS,EACT,KAAU,EACV,QAAQ,EACR,KAAK,EACL,QAAa,EACb,SAAc,EACd,QAA2B,EAC3B,SAA4B,EAC5B,eAAuB,EACvB,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,WAAW,GACZ,EAAE,kBAAkB,2CAiKpB;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,2CAE9D;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,2DAAsB,CAAC"}
@@ -1,3 +1,27 @@
1
1
  import type { NodeResizerProps } from './types';
2
+ /**
3
+ * The `<NodeResizer />` component can be used to add a resize functionality to your
4
+ * nodes. It renders draggable controls around the node to resize in all directions.
5
+ * @public
6
+ *
7
+ * @example
8
+ *```jsx
9
+ *import { memo } from 'react';
10
+ *import { Handle, Position, NodeResizer } from '@xyflow/react';
11
+ *
12
+ *function ResizableNode({ data }) {
13
+ * return (
14
+ * <>
15
+ * <NodeResizer minWidth={100} minHeight={30} />
16
+ * <Handle type="target" position={Position.Left} />
17
+ * <div style={{ padding: 10 }}>{data.label}</div>
18
+ * <Handle type="source" position={Position.Right} />
19
+ * </>
20
+ * );
21
+ *};
22
+ *
23
+ *export default memo(ResizableNode);
24
+ *```
25
+ */
2
26
  export declare function NodeResizer({ nodeId, isVisible, handleClassName, handleStyle, lineClassName, lineStyle, color, minWidth, minHeight, maxWidth, maxHeight, keepAspectRatio, shouldResize, onResizeStart, onResize, onResizeEnd, }: NodeResizerProps): import("react/jsx-runtime").JSX.Element | null;
3
27
  //# sourceMappingURL=NodeResizer.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"NodeResizer.d.ts","sourceRoot":"","sources":["../../../src/additional-components/NodeResizer/NodeResizer.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD,wBAAgB,WAAW,CAAC,EAC1B,MAAM,EACN,SAAgB,EAChB,eAAe,EACf,WAAW,EACX,aAAa,EACb,SAAS,EACT,KAAK,EACL,QAAa,EACb,SAAc,EACd,QAA2B,EAC3B,SAA4B,EAC5B,eAAuB,EACvB,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,WAAW,GACZ,EAAE,gBAAgB,kDAgDlB"}
1
+ {"version":3,"file":"NodeResizer.d.ts","sourceRoot":"","sources":["../../../src/additional-components/NodeResizer/NodeResizer.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,WAAW,CAAC,EAC1B,MAAM,EACN,SAAgB,EAChB,eAAe,EACf,WAAW,EACX,aAAa,EACb,SAAS,EACT,KAAK,EACL,QAAa,EACb,SAAc,EACd,QAA2B,EAC3B,SAA4B,EAC5B,eAAuB,EACvB,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,WAAW,GACZ,EAAE,gBAAgB,kDAgDlB"}
@@ -1,7 +1,11 @@
1
1
  import type { CSSProperties, ReactNode } from 'react';
2
2
  import type { ControlPosition, ControlLinePosition, ResizeControlVariant, ShouldResize, OnResizeStart, OnResize, OnResizeEnd } from '@xyflow/system';
3
+ /**
4
+ * @expand
5
+ */
3
6
  export type NodeResizerProps = {
4
- /** Id of the node it is resizing
7
+ /**
8
+ * Id of the node it is resizing
5
9
  * @remarks optional if used inside custom node
6
10
  */
7
11
  nodeId?: string;
@@ -36,13 +40,18 @@ export type NodeResizerProps = {
36
40
  /** Callback called when resizing ends */
37
41
  onResizeEnd?: OnResizeEnd;
38
42
  };
43
+ /**
44
+ * @expand
45
+ */
39
46
  export type ResizeControlProps = Pick<NodeResizerProps, 'nodeId' | 'color' | 'minWidth' | 'minHeight' | 'maxWidth' | 'maxHeight' | 'keepAspectRatio' | 'shouldResize' | 'onResizeStart' | 'onResize' | 'onResizeEnd'> & {
40
- /** Position of the control
47
+ /**
48
+ * Position of the control
41
49
  * @example ControlPosition.TopLeft, ControlPosition.TopRight,
42
50
  * ControlPosition.BottomLeft, ControlPosition.BottomRight
43
51
  */
44
52
  position?: ControlPosition;
45
- /** Variant of the control
53
+ /**
54
+ * Variant of the control
46
55
  * @example ResizeControlVariant.Handle, ResizeControlVariant.Line
47
56
  */
48
57
  variant?: ResizeControlVariant;
@@ -50,6 +59,9 @@ export type ResizeControlProps = Pick<NodeResizerProps, 'nodeId' | 'color' | 'mi
50
59
  style?: CSSProperties;
51
60
  children?: ReactNode;
52
61
  };
62
+ /**
63
+ * @expand
64
+ */
53
65
  export type ResizeControlLineProps = ResizeControlProps & {
54
66
  position?: ControlLinePosition;
55
67
  };
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/additional-components/NodeResizer/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACtD,OAAO,KAAK,EACV,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,WAAW,EACZ,MAAM,gBAAgB,CAAC;AAExB,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,8BAA8B;IAC9B,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,gCAAgC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,4BAA4B;IAC5B,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,+BAA+B;IAC/B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,kDAAkD;IAClD,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,2CAA2C;IAC3C,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,oCAAoC;IACpC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,yCAAyC;IACzC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,gBAAgB,EACd,QAAQ,GACR,OAAO,GACP,UAAU,GACV,WAAW,GACX,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,cAAc,GACd,eAAe,GACf,UAAU,GACV,aAAa,CAChB,GAAG;IACF;;;OAGG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,GAAG;IACxD,QAAQ,CAAC,EAAE,mBAAmB,CAAC;CAChC,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/additional-components/NodeResizer/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACtD,OAAO,KAAK,EACV,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,WAAW,EACZ,MAAM,gBAAgB,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,8BAA8B;IAC9B,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,gCAAgC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,4BAA4B;IAC5B,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,+BAA+B;IAC/B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,kDAAkD;IAClD,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,2CAA2C;IAC3C,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,oCAAoC;IACpC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,yCAAyC;IACzC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACnC,gBAAgB,EACd,QAAQ,GACR,OAAO,GACP,UAAU,GACV,WAAW,GACX,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,cAAc,GACd,eAAe,GACf,UAAU,GACV,aAAa,CAChB,GAAG;IACF;;;;OAIG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B;;;OAGG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,GAAG;IACxD,QAAQ,CAAC,EAAE,mBAAmB,CAAC;CAChC,CAAC"}
@@ -1,3 +1,38 @@
1
1
  import type { NodeToolbarProps } from './types';
2
+ /**
3
+ * This component can render a toolbar or tooltip to one side of a custom node. This
4
+ * toolbar doesn't scale with the viewport so that the content is always visible.
5
+ *
6
+ * @public
7
+ * @example
8
+ * ```jsx
9
+ *import { memo } from 'react';
10
+ *import { Handle, Position, NodeToolbar } from '@xyflow/react';
11
+ *
12
+ *function CustomNode({ data }) {
13
+ * return (
14
+ * <>
15
+ * <NodeToolbar isVisible={data.toolbarVisible} position={data.toolbarPosition}>
16
+ * <button>delete</button>
17
+ * <button>copy</button>
18
+ * <button>expand</button>
19
+ * </NodeToolbar>
20
+ *
21
+ * <div style={{ padding: '10px 20px' }}>
22
+ * {data.label}
23
+ * </div>
24
+ *
25
+ * <Handle type="target" position={Position.Left} />
26
+ * <Handle type="source" position={Position.Right} />
27
+ * </>
28
+ * );
29
+ *};
30
+ *
31
+ *export default memo(CustomNode);
32
+ *```
33
+ * @remarks By default, the toolbar is only visible when a node is selected. If multiple
34
+ * nodes are selected it will not be visible to prevent overlapping toolbars or
35
+ * clutter. You can override this behavior by setting the `isVisible` prop to `true`.
36
+ */
2
37
  export declare function NodeToolbar({ nodeId, children, className, style, isVisible, position, offset, align, ...rest }: NodeToolbarProps): import("react/jsx-runtime").JSX.Element | null;
3
38
  //# sourceMappingURL=NodeToolbar.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"NodeToolbar.d.ts","sourceRoot":"","sources":["../../../src/additional-components/NodeToolbar/NodeToolbar.tsx"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AA+BhD,wBAAgB,WAAW,CAAC,EAC1B,MAAM,EACN,QAAQ,EACR,SAAS,EACT,KAAK,EACL,SAAS,EACT,QAAuB,EACvB,MAAW,EACX,KAAgB,EAChB,GAAG,IAAI,EACR,EAAE,gBAAgB,kDAwDlB"}
1
+ {"version":3,"file":"NodeToolbar.d.ts","sourceRoot":"","sources":["../../../src/additional-components/NodeToolbar/NodeToolbar.tsx"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AA+BhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,WAAW,CAAC,EAC1B,MAAM,EACN,QAAQ,EACR,SAAS,EACT,KAAK,EACL,SAAS,EACT,QAAuB,EACvB,MAAW,EACX,KAAgB,EAChB,GAAG,IAAI,EACR,EAAE,gBAAgB,kDAwDlB"}
@@ -1,18 +1,23 @@
1
1
  import type { HTMLAttributes } from 'react';
2
2
  import type { Position, Align } from '@xyflow/system';
3
+ /**
4
+ * @expand
5
+ */
3
6
  export type NodeToolbarProps = HTMLAttributes<HTMLDivElement> & {
4
7
  /** Id of the node, or array of ids the toolbar should be displayed at */
5
8
  nodeId?: string | string[];
6
9
  /** If true, node toolbar is visible even if node is not selected */
7
10
  isVisible?: boolean;
8
- /** Position of the toolbar relative to the node
11
+ /**
12
+ * Position of the toolbar relative to the node
9
13
  * @example Position.TopLeft, Position.TopRight,
10
14
  * Position.BottomLeft, Position.BottomRight
11
15
  */
12
16
  position?: Position;
13
17
  /** Offset the toolbar from the node */
14
18
  offset?: number;
15
- /** Align the toolbar relative to the node
19
+ /**
20
+ * Align the toolbar relative to the node
16
21
  * @example Align.Start, Align.Center, Align.End
17
22
  */
18
23
  align?: Align;
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/additional-components/NodeToolbar/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEtD,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAAC,cAAc,CAAC,GAAG;IAC9D,yEAAyE;IACzE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,oEAAoE;IACpE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/additional-components/NodeToolbar/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAAC,cAAc,CAAC,GAAG;IAC9D,yEAAyE;IACzE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,oEAAoE;IACpE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/BatchProvider/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,SAAS,EAAoC,MAAM,OAAO,CAAC;AAKnF,OAAO,EAAE,KAAK,EAAa,MAAM,SAAS,CAAC;AAC3C,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAU9C;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,QAAQ,SAAS,IAAI,GAAG,IAAI,EAAE,QAAQ,SAAS,IAAI,GAAG,IAAI,EAAE,EACxF,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,2CAmDA;AAED,wBAAgB,eAAe;;;EAQ9B"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/BatchProvider/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,SAAS,EAAoC,MAAM,OAAO,CAAC;AAKnF,OAAO,EAAE,KAAK,EAAa,MAAM,SAAS,CAAC;AAC3C,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAU9C;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,QAAQ,SAAS,IAAI,GAAG,IAAI,EAAE,QAAQ,SAAS,IAAI,GAAG,IAAI,EAAE,EACxF,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,2CAqDA;AAED,wBAAgB,eAAe;;;EAQ9B"}
@@ -1 +1 @@
1
- {"version":3,"file":"useQueue.d.ts","sourceRoot":"","sources":["../../../src/components/BatchProvider/useQueue.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE3C;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,YA2BpE"}
1
+ {"version":3,"file":"useQueue.d.ts","sourceRoot":"","sources":["../../../src/components/BatchProvider/useQueue.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE3C;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,YAiCpE"}
@@ -1,12 +1,12 @@
1
1
  import { CSSProperties } from 'react';
2
2
  import { ConnectionLineType } from '@xyflow/system';
3
- import type { ConnectionLineComponent } from '../../types';
4
- type ConnectionLineWrapperProps = {
3
+ import type { ConnectionLineComponent, Node } from '../../types';
4
+ type ConnectionLineWrapperProps<NodeType extends Node = Node> = {
5
5
  type: ConnectionLineType;
6
- component?: ConnectionLineComponent;
6
+ component?: ConnectionLineComponent<NodeType>;
7
7
  containerStyle?: CSSProperties;
8
8
  style?: CSSProperties;
9
9
  };
10
- export declare function ConnectionLineWrapper({ containerStyle, style, type, component }: ConnectionLineWrapperProps): import("react/jsx-runtime").JSX.Element | null;
10
+ export declare function ConnectionLineWrapper<NodeType extends Node = Node>({ containerStyle, style, type, component, }: ConnectionLineWrapperProps<NodeType>): import("react/jsx-runtime").JSX.Element | null;
11
11
  export {};
12
12
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/ConnectionLine/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAGtC,OAAO,EACL,kBAAkB,EAKnB,MAAM,gBAAgB,CAAC;AAIxB,OAAO,KAAK,EAAE,uBAAuB,EAAkB,MAAM,aAAa,CAAC;AAG3E,KAAK,0BAA0B,GAAG;IAChC,IAAI,EAAE,kBAAkB,CAAC;IACzB,SAAS,CAAC,EAAE,uBAAuB,CAAC;IACpC,cAAc,CAAC,EAAE,aAAa,CAAC;IAC/B,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC;AAUF,wBAAgB,qBAAqB,CAAC,EAAE,cAAc,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,0BAA0B,kDAoB3G"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/ConnectionLine/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAGtC,OAAO,EACL,kBAAkB,EAKnB,MAAM,gBAAgB,CAAC;AAIxB,OAAO,KAAK,EAAE,uBAAuB,EAAE,IAAI,EAAkB,MAAM,aAAa,CAAC;AAGjF,KAAK,0BAA0B,CAAC,QAAQ,SAAS,IAAI,GAAG,IAAI,IAAI;IAC9D,IAAI,EAAE,kBAAkB,CAAC;IACzB,SAAS,CAAC,EAAE,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAC9C,cAAc,CAAC,EAAE,aAAa,CAAC;IAC/B,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC;AAUF,wBAAgB,qBAAqB,CAAC,QAAQ,SAAS,IAAI,GAAG,IAAI,EAAE,EAClE,cAAc,EACd,KAAK,EACL,IAAI,EACJ,SAAS,GACV,EAAE,0BAA0B,CAAC,QAAQ,CAAC,kDAoBtC"}
@@ -1,4 +1,44 @@
1
1
  import type { ReactNode } from 'react';
2
+ /**
3
+ * Edges are SVG-based. If you want to render more complex labels you can use the
4
+ * `<EdgeLabelRenderer />` component to access a div based renderer. This component
5
+ * is a portal that renders the label in a `<div />` that is positioned on top of
6
+ * the edges. You can see an example usage of the component in the [edge label renderer](/examples/edges/edge-label-renderer) example.
7
+ * @public
8
+ *
9
+ * @example
10
+ *```jsx
11
+ *import React from 'react';
12
+ *import { getBezierPath, EdgeLabelRenderer, BaseEdge } from '@xyflow/react';
13
+ *
14
+ *export function CustomEdge({ id, data, ...props }) {
15
+ * const [edgePath, labelX, labelY] = getBezierPath(props);
16
+ *
17
+ * return (
18
+ * <>
19
+ * <BaseEdge id={id} path={edgePath} />
20
+ * <EdgeLabelRenderer>
21
+ * <div
22
+ * style={{
23
+ * position: 'absolute',
24
+ * transform: `translate(-50%, -50%) translate(${labelX}px,${labelY}px)`,
25
+ * background: '#ffcc00',
26
+ * padding: 10,
27
+ * }}
28
+ * className="nodrag nopan"
29
+ * >
30
+ * {data.label}
31
+ * </div>
32
+ * </EdgeLabelRenderer>
33
+ * </>
34
+ * );
35
+ *};
36
+ *```
37
+ *
38
+ * @remarks The `<EdgeLabelRenderer />` has no pointer events by default. If you want to
39
+ * add mouse interactions you need to set the style `pointerEvents: all` and add
40
+ * the `nopan` class on the label or the element you want to interact with.
41
+ */
2
42
  export declare function EdgeLabelRenderer({ children }: {
3
43
  children: ReactNode;
4
44
  }): import("react").ReactPortal | null;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/EdgeLabelRenderer/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAQvC,wBAAgB,iBAAiB,CAAC,EAAE,QAAQ,EAAE,EAAE;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,sCAQtE"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/EdgeLabelRenderer/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAQvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,QAAQ,EAAE,EAAE;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,sCAQtE"}
@@ -1,4 +1,4 @@
1
- /// <reference types="react" />
1
+ import { JSX } from 'react';
2
2
  import type { Edge, EdgeWrapperProps } from '../../types';
3
3
  export declare function EdgeWrapper<EdgeType extends Edge = Edge>({ id, edgesFocusable, edgesReconnectable, elementsSelectable, onClick, onDoubleClick, onContextMenu, onMouseEnter, onMouseMove, onMouseLeave, reconnectRadius, onReconnect, onReconnectStart, onReconnectEnd, rfId, edgeTypes, noPanClassName, onError, disableKeyboardA11y, }: EdgeWrapperProps<EdgeType>): JSX.Element | null;
4
4
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/EdgeWrapper/index.tsx"],"names":[],"mappings":";AAeA,OAAO,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE1D,wBAAgB,WAAW,CAAC,QAAQ,SAAS,IAAI,GAAG,IAAI,EAAE,EACxD,EAAE,EACF,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,OAAO,EACP,aAAa,EACb,aAAa,EACb,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,eAAe,EACf,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,IAAI,EACJ,SAAS,EACT,cAAc,EACd,OAAO,EACP,mBAAmB,GACpB,EAAE,gBAAgB,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,OAAO,GAAG,IAAI,CAiOjD"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/EdgeWrapper/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA8D,GAAG,EAAE,MAAM,OAAO,CAAC;AAexF,OAAO,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE1D,wBAAgB,WAAW,CAAC,QAAQ,SAAS,IAAI,GAAG,IAAI,EAAE,EACxD,EAAE,EACF,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,OAAO,EACP,aAAa,EACb,aAAa,EACb,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,eAAe,EACf,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,IAAI,EACJ,SAAS,EACT,cAAc,EACd,OAAO,EACP,mBAAmB,GACpB,EAAE,gBAAgB,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,OAAO,GAAG,IAAI,CAiOjD"}
@@ -1,3 +1,30 @@
1
1
  import type { BaseEdgeProps } from '../../types';
2
+ /**
3
+ * The `<BaseEdge />` component gets used internally for all the edges. It can be
4
+ * used inside a custom edge and handles the invisible helper edge and the edge label
5
+ * for you.
6
+ *
7
+ * @public
8
+ * @example
9
+ * ```jsx
10
+ *import { BaseEdge } from '@xyflow/react';
11
+ *
12
+ *export function CustomEdge({ sourceX, sourceY, targetX, targetY, ...props }) {
13
+ * const [edgePath] = getStraightPath({
14
+ * sourceX,
15
+ * sourceY,
16
+ * targetX,
17
+ * targetY,
18
+ * });
19
+ *
20
+ * return <BaseEdge path={edgePath} {...props} />;
21
+ *}
22
+ *```
23
+ *
24
+ * @remarks If you want to use an edge marker with the [`<BaseEdge />`](/api-reference/components/base-edge) component,
25
+ * you can pass the `markerStart` or `markerEnd` props passed to your custom edge
26
+ * through to the [`<BaseEdge />`](/api-reference/components/base-edge) component.
27
+ * You can see all the props passed to a custom edge by looking at the [`EdgeProps`](/api-reference/types/edge-props) type.
28
+ */
2
29
  export declare function BaseEdge({ path, labelX, labelY, label, labelStyle, labelShowBg, labelBgStyle, labelBgPadding, labelBgBorderRadius, interactionWidth, ...props }: BaseEdgeProps): import("react/jsx-runtime").JSX.Element;
3
30
  //# sourceMappingURL=BaseEdge.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"BaseEdge.d.ts","sourceRoot":"","sources":["../../../src/components/Edges/BaseEdge.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEjD,wBAAgB,QAAQ,CAAC,EACvB,IAAI,EACJ,MAAM,EACN,MAAM,EACN,KAAK,EACL,UAAU,EACV,WAAW,EACX,YAAY,EACZ,cAAc,EACd,mBAAmB,EACnB,gBAAqB,EACrB,GAAG,KAAK,EACT,EAAE,aAAa,2CA2Bf"}
1
+ {"version":3,"file":"BaseEdge.d.ts","sourceRoot":"","sources":["../../../src/components/Edges/BaseEdge.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,QAAQ,CAAC,EACvB,IAAI,EACJ,MAAM,EACN,MAAM,EACN,KAAK,EACL,UAAU,EACV,WAAW,EACX,YAAY,EACZ,cAAc,EACd,mBAAmB,EACnB,gBAAqB,EACrB,GAAG,KAAK,EACT,EAAE,aAAa,2CA2Bf"}