@xyflow/react 12.0.0-next.6 → 12.0.0-next.8

package/dist/esm/types/component-props.d.ts

@@ -1,124 +1,462 @@
 import type { CSSProperties, HTMLAttributes, MouseEvent as ReactMouseEvent, WheelEvent } from 'react';
-import type { ConnectionMode, ConnectionLineType, OnConnect, OnConnectStart, OnConnectEnd, CoordinateExtent, KeyCode, PanOnScrollMode, ProOptions, PanelPosition, OnMove, OnMoveStart, OnMoveEnd, Viewport, NodeOrigin, HandleType, SelectionMode, OnError, IsValidConnection, ColorMode, SnapGrid, OnBeforeDelete } from '@xyflow/system';
-import type { OnSelectionChangeFunc, NodeTypes, EdgeTypes, Node, Edge, ConnectionLineComponent, OnEdgeUpdateFunc, OnInit, DefaultEdgeOptions, FitViewOptions, OnNodesDelete, OnEdgesDelete, OnDelete, OnNodesChange, OnEdgesChange, NodeDragHandler, NodeMouseHandler, SelectionDragHandler, EdgeMouseHandler } from '.';
+import type { ConnectionMode, ConnectionLineType, OnConnect, OnConnectStart, OnConnectEnd, CoordinateExtent, KeyCode, PanOnScrollMode, ProOptions, PanelPosition, OnMove, OnMoveStart, OnMoveEnd, Viewport, NodeOrigin, HandleType, SelectionMode, OnError, IsValidConnection, ColorMode, SnapGrid } from '@xyflow/system';
+import type { OnSelectionChangeFunc, NodeTypes, EdgeTypes, Node, Edge, ConnectionLineComponent, OnEdgeUpdateFunc, OnInit, DefaultEdgeOptions, FitViewOptions, OnNodesDelete, OnEdgesDelete, OnDelete, OnNodesChange, OnEdgesChange, NodeMouseHandler, SelectionDragHandler, EdgeMouseHandler, OnNodeDrag, OnBeforeDelete } from '.';
 /**
  * ReactFlow component props.
  * @public
  */
-export type ReactFlowProps = Omit<HTMLAttributes<HTMLDivElement>, 'onError'> & {
+export interface ReactFlowProps extends Omit<HTMLAttributes<HTMLDivElement>, 'onError'> {
+    /** An array of nodes to render in a controlled flow.
+     * @example
+     * const nodes = [
+     *  {
+     *    id: 'node-1',
+     *    type: 'input',
+     *    data: { label: 'Node 1' },
+     *    position: { x: 250, y: 50 }
+     *  }
+     * ];
+     */
     nodes?: Node[];
+    /** An array of edges to render in a controlled flow.
+     * @example
+     * const edges = [
+     *  {
+     *    id: 'edge-1-2',
+     *    source: 'node-1',
+     *    target: 'node-2',
+     *  }
+     * ];
+     */
     edges?: Edge[];
+    /** The initial nodes to render in an uncontrolled flow. */
     defaultNodes?: Node[];
+    /** The initial edges to render in an uncontrolled flow. */
     defaultEdges?: Edge[];
+    /** Defaults to be applied to all new edges that are added to the flow.
+     *
+     * Properties on a new edge will override these defaults if they exist.
+     * @example
+     * const defaultEdgeOptions = {
+     *  type: 'customEdgeType',
+     *  animated: true,
+     *  interactionWidth: 10,
+     *  data: { label: 'custom label' },
+     *  hidden: false,
+     *  deletable: true,
+     *  selected: false,
+     *  focusable: true,
+     *  markerStart: EdgeMarker.ArrowClosed,
+     *  markerEnd: EdgeMarker.ArrowClosed,
+     *  zIndex: 12,
+     *  ariaLabel: 'custom aria label'
+     * }
+     */
     defaultEdgeOptions?: DefaultEdgeOptions;
+    /** This event handler is called when a user clicks on a node */
     onNodeClick?: NodeMouseHandler;
+    /** This event handler is called when a user double clicks on a node */
     onNodeDoubleClick?: NodeMouseHandler;
+    /** This event handler is called when mouse of a user enters a node */
     onNodeMouseEnter?: NodeMouseHandler;
+    /** This event handler is called when mouse of a user moves over a node */
     onNodeMouseMove?: NodeMouseHandler;
+    /** This event handler is called when mouse of a user leaves a node */
     onNodeMouseLeave?: NodeMouseHandler;
+    /** This event handler is called when a user right clicks on a node */
     onNodeContextMenu?: NodeMouseHandler;
-    onNodeDragStart?: NodeDragHandler;
-    onNodeDrag?: NodeDragHandler;
-    onNodeDragStop?: NodeDragHandler;
+    /** This event handler is called when a user starts to drag a node */
+    onNodeDragStart?: OnNodeDrag;
+    /** This event handler is called when a user drags a node */
+    onNodeDrag?: OnNodeDrag;
+    /** This event handler is called when a user stops dragging a node */
+    onNodeDragStop?: OnNodeDrag;
+    /** This event handler is called when a user clicks on an edge */
     onEdgeClick?: (event: ReactMouseEvent, edge: Edge) => void;
-    onEdgeUpdate?: OnEdgeUpdateFunc;
+    /** This event handler is called when a user right clicks on an edge */
     onEdgeContextMenu?: EdgeMouseHandler;
+    /** This event handler is called when mouse of a user enters an edge */
     onEdgeMouseEnter?: EdgeMouseHandler;
+    /** This event handler is called when mouse of a user moves over an edge */
     onEdgeMouseMove?: EdgeMouseHandler;
+    /** This event handler is called when mouse of a user leaves an edge */
     onEdgeMouseLeave?: EdgeMouseHandler;
+    /** This event handler is called when a user double clicks on an edge */
     onEdgeDoubleClick?: EdgeMouseHandler;
     onEdgeUpdateStart?: (event: ReactMouseEvent, edge: Edge, handleType: HandleType) => void;
     onEdgeUpdateEnd?: (event: MouseEvent | TouchEvent, edge: Edge, handleType: HandleType) => void;
+    onEdgeUpdate?: OnEdgeUpdateFunc;
+    /** This event handler is called when a Node is updated
+     * @example // Use NodesState hook to create edges and get onNodesChange handler
+     * import ReactFlow, { useNodesState } from '@xyflow/react';
+     * const [edges, setNodes, onNodesChange] = useNodesState(initialNodes);
+     *
+     * return (<ReactFlow onNodeChange={onNodeChange} {...rest} />)
+     * @example // Use helper function to update edge
+     * import ReactFlow, { applyNodeChanges } from '@xyflow/react';
+     *
+     * const onNodeChange = useCallback(
+     *  (changes) => setNode((eds) => applyNodeChanges(changes, eds)),
+     *  [],
+     * );
+     *
+     * return (<ReactFlow onNodeChange={onNodeChange} {...rest} />)
+     */
     onNodesChange?: OnNodesChange;
+    /** This event handler is called when a Edge is updated
+     * @example // Use EdgesState hook to create edges and get onEdgesChange handler
+     * import ReactFlow, { useEdgesState } from '@xyflow/react';
+     * const [edges, setEdges, onEdgesChange] = useEdgesState(initialEdges);
+     *
+     * return (<ReactFlow onEdgesChange={onEdgesChange} {...rest} />)
+     * @example // Use helper function to update edge
+     * import ReactFlow, { applyEdgeChanges } from '@xyflow/react';
+     *
+     * const onEdgesChange = useCallback(
+     *  (changes) => setEdges((eds) => applyEdgeChanges(changes, eds)),
+     *  [],
+     * );
+     *
+     * return (<ReactFlow onEdgesChange={onEdgesChange} {...rest} />)
+     */
     onEdgesChange?: OnEdgesChange;
+    /** This event handler gets called when a Node is deleted */
     onNodesDelete?: OnNodesDelete;
+    /** This event handler gets called when a Edge is deleted */
     onEdgesDelete?: OnEdgesDelete;
+    /** This event handler gets called when a Node or Edge is deleted */
     onDelete?: OnDelete;
+    /** This event handler gets called when a user starts to drag a selection box */
     onSelectionDragStart?: SelectionDragHandler;
+    /** This event handler gets called when a user drags a selection box */
     onSelectionDrag?: SelectionDragHandler;
+    /** This event handler gets called when a user stops dragging a selection box */
     onSelectionDragStop?: SelectionDragHandler;
     onSelectionStart?: (event: ReactMouseEvent) => void;
     onSelectionEnd?: (event: ReactMouseEvent) => void;
     onSelectionContextMenu?: (event: ReactMouseEvent, nodes: Node[]) => void;
+    /** When a connection line is completed and two nodes are connected by the user, this event fires with the new connection.
+     *
+     * You can use the addEdge utility to convert the connection to a complete edge.
+     * @example // Use helper function to update edges onConnect
+     * import ReactFlow, { addEdge } from '@xyflow/react';
+     *
+     * const onConnect = useCallback(
+     *  (params) => setEdges((eds) => addEdge(params, eds)),
+     *  [],
+     * );
+     *
+     * return (<ReactFlow onConnect={onConnect} {...rest} />)
+     */
     onConnect?: OnConnect;
+    /** This event handler gets called when a user starts to drag a connection line */
     onConnectStart?: OnConnectStart;
+    /** This event handler gets called when a user stops dragging a connection line */
     onConnectEnd?: OnConnectEnd;
     onClickConnectStart?: OnConnectStart;
     onClickConnectEnd?: OnConnectEnd;
+    /** This event handler gets called when a flow has finished initializing */
     onInit?: OnInit;
+    /** This event handler is called while the user is either panning or zooming the viewport. */
     onMove?: OnMove;
+    /** This event handler gets called when a user starts to pan or zoom the viewport */
     onMoveStart?: OnMoveStart;
+    /** This event handler gets called when a user stops panning or zooming the viewport */
     onMoveEnd?: OnMoveEnd;
+    /** This event handler gets called when a user changes group of selected elements in the flow */
     onSelectionChange?: OnSelectionChangeFunc;
+    /** This event handler gets called when user scroll inside the pane */
     onPaneScroll?: (event?: WheelEvent) => void;
+    /** This event handler gets called when user clicks inside the pane */
     onPaneClick?: (event: ReactMouseEvent) => void;
+    /** This event handler gets called when user right clicks inside the pane */
     onPaneContextMenu?: (event: ReactMouseEvent | MouseEvent) => void;
+    /** This event handler gets called when mouse enters the pane */
     onPaneMouseEnter?: (event: ReactMouseEvent) => void;
+    /** This event handler gets called when mouse moves over the pane */
     onPaneMouseMove?: (event: ReactMouseEvent) => void;
+    /** This event handler gets called when mouse leaves the pane */
     onPaneMouseLeave?: (event: ReactMouseEvent) => void;
+    /** This handler gets called before the user deletes nodes or edges and provides a way to abort the deletion by returning false. */
     onBeforeDelete?: OnBeforeDelete;
+    /** Custom node types to be available in a flow.
+     *
+     * React Flow matches a node's type to a component in the nodeTypes object.
+     * @example
+     * import CustomNode from './CustomNode';
+     *
+     * const nodeTypes = { nameOfNodeType: CustomNode };
+     */
     nodeTypes?: NodeTypes;
+    /** Custom edge types to be available in a flow.
+     *
+     * React Flow matches an edge's type to a component in the edgeTypes object.
+     * @example
+     * import CustomEdge from './CustomEdge';
+     *
+     * const edgeTypes = { nameOfEdgeType: CustomEdge };
+     */
     edgeTypes?: EdgeTypes;
+    /** The type of edge path to use for connection lines.
+     *
+     * Although created edges can be of any type, React Flow needs to know what type of path to render for the connection line before the edge is created!
+     */
     connectionLineType?: ConnectionLineType;
+    /** Styles to be applied to the connection line */
     connectionLineStyle?: CSSProperties;
+    /** React Component to be used as a connection line */
     connectionLineComponent?: ConnectionLineComponent;
+    /** Styles to be applied to the container of the connection line */
     connectionLineContainerStyle?: CSSProperties;
+    /** 'strict' connection mode will only allow you to connect source handles to target handles.
+     *
+     * 'loose' connection mode will allow you to connect handles of any type to one another.
+     * @default 'strict'
+     */
     connectionMode?: ConnectionMode;
+    /** Pressing down this key deletes all selected nodes & edges.
+     * @default 'Backspace'
+     */
     deleteKeyCode?: KeyCode | null;
+    /** If a key is set, you can pan the viewport while that key is held down even if panOnScroll is set to false.
+     *
+     * By setting this prop to null you can disable this functionality.
+     * @default 'Space'
+     */
     selectionKeyCode?: KeyCode | null;
+    /** Select multiple elements with a selection box, without pressing down selectionKey */
     selectionOnDrag?: boolean;
+    /** When set to "partial", when the user creates a selection box by click and dragging nodes that are only partially in the box are still selected.
+     * @default 'full'
+     */
     selectionMode?: SelectionMode;
+    /** If a key is set, you can pan the viewport while that key is held down even if panOnScroll is set to false.
+     *
+     * By setting this prop to null you can disable this functionality.
+     * @default 'Space'
+     */
     panActivationKeyCode?: KeyCode | null;
+    /** Pressing down this key you can select multiple elements by clicking.
+     * @default 'Meta' for macOS, "Ctrl" for other systems
+     */
     multiSelectionKeyCode?: KeyCode | null;
+    /** If a key is set, you can zoom the viewport while that key is held down even if panOnScroll is set to false.
+     *
+     * By setting this prop to null you can disable this functionality.
+     * @default 'Meta' for macOS, "Ctrl" for other systems
+     * */
     zoomActivationKeyCode?: KeyCode | null;
+    /** Set this prop to make the flow snap to the grid */
     snapToGrid?: boolean;
+    /** Grid all nodes will snap to
+     * @example [20, 20]
+     */
     snapGrid?: SnapGrid;
+    /** You can enable this optimisation to instruct Svelte Flow to only render nodes and edges that would be visible in the viewport.
+     *
+     * This might improve performance when you have a large number of nodes and edges but also adds an overhead.
+     * @default false
+     */
     onlyRenderVisibleElements?: boolean;
+    /** Controls if all nodes should be draggable
+     * @default true
+     */
     nodesDraggable?: boolean;
+    /** Controls if all nodes should be connectable to each other
+     * @default true
+     */
     nodesConnectable?: boolean;
+    /** Controls if all nodes should be focusable
+     * @default true
+     */
     nodesFocusable?: boolean;
+    /** Defines nodes relative position to its coordinates
+     * @example
+     * [0, 0] // default, top left
+     * [0.5, 0.5] // center
+     * [1, 1] // bottom right
+     */
     nodeOrigin?: NodeOrigin;
+    /** Controls if all edges should be focusable
+     * @default true
+     */
     edgesFocusable?: boolean;
+    /** Controls if all edges should be updateable
+     * @default true
+     */
     edgesUpdatable?: boolean;
+    /** Controls if all elements should (nodes & edges) be selectable
+     * @default true
+     */
     elementsSelectable?: boolean;
+    /** If true, nodes get selected on drag
+     * @default true
+     */
     selectNodesOnDrag?: boolean;
+    /** Enableing this prop allows users to pan the viewport by clicking and dragging.
+     *
+     * You can also set this prop to an array of numbers to limit which mouse buttons can activate panning.
+     * @example [0, 2] // allows panning with the left and right mouse buttons
+     * [0, 1, 2, 3, 4] // allows panning with all mouse buttons
+     */
     panOnDrag?: boolean | number[];
+    /** Minimum zoom level
+     * @default 0.1
+     */
     minZoom?: number;
+    /** Maximum zoom level
+     * @default 1
+     */
     maxZoom?: number;
+    /** Controlled viewport to be used instead of internal one */
     viewport?: Viewport;
+    /** Sets the initial position and zoom of the viewport.
+     *
+     * If a default viewport is provided but fitView is enabled, the default viewport will be ignored.
+     * @example
+     * const initialViewport = {
+     *  zoom: 0.5,
+     *  position: { x: 0, y: 0 }
+     * };
+     */
     defaultViewport?: Viewport;
+    /**
+     * Gets called when the viewport changes.
+     */
     onViewportChange?: (viewport: Viewport) => void;
+    /** By default the viewport extends infinitely. You can use this prop to set a boundary.
+     *
+     * The first pair of coordinates is the top left boundary and the second pair is the bottom right.
+     * @example [[-1000, -10000], [1000, 1000]]
+     */
     translateExtent?: CoordinateExtent;
+    /** Disabling this prop will allow the user to scroll the page even when their pointer is over the flow.
+     * @default true
+     */
     preventScrolling?: boolean;
+    /** By default nodes can be placed on an infinite flow. You can use this prop to set a boundary.
+     *
+     * The first pair of coordinates is the top left boundary and the second pair is the bottom right.
+     * @example [[-1000, -10000], [1000, 1000]]
+     */
     nodeExtent?: CoordinateExtent;
+    /** Color of edge markers
+     * @example "#b1b1b7"
+     */
     defaultMarkerColor?: string;
+    /** Controls if the viewport should zoom by scrolling inside the container */
     zoomOnScroll?: boolean;
+    /** Controls if the viewport should zoom by pinching on a touch screen */
     zoomOnPinch?: boolean;
+    /** Controls if the viewport should pan by scrolling inside the container
+     *
+     * Can be limited to a specific direction with panOnScrollMode
+     */
     panOnScroll?: boolean;
+    /** Controls how fast viewport should be panned on scroll.
+     *
+     * Use togther with panOnScroll prop.
+     */
     panOnScrollSpeed?: number;
+    /** This prop is used to limit the direction of panning when panOnScroll is enabled.
+     *
+     * The "free" option allows panning in any direction.
+     * @default "free"
+     * @example "horizontal" | "vertical"
+     */
     panOnScrollMode?: PanOnScrollMode;
+    /** Controls if the viewport should zoom by double clicking somewhere on the flow */
     zoomOnDoubleClick?: boolean;
     edgeUpdaterRadius?: number;
     noDragClassName?: string;
     noWheelClassName?: string;
     noPanClassName?: string;
+    /** If set, initial viewport will show all nodes & edges */
     fitView?: boolean;
+    /** Options to be used in combination with fitView
+     * @example
+     * const fitViewOptions = {
+     *  padding: 0.1,
+     *  includeHiddenNodes: false,
+     *  minZoom: 0.1,
+     *  maxZoom: 1,
+     *  duration: 200,
+     *  nodes: [{id: 'node-1'}, {id: 'node-2'}], // nodes to fit
+     * };
+     */
     fitViewOptions?: FitViewOptions;
+    /**The connectOnClick option lets you click or tap on a source handle to start a connection
+     * and then click on a target handle to complete the connection.
+     *
+     * If you set this option to false, users will need to drag the connection line to the target
+     * handle to create a connection.
+     */
     connectOnClick?: boolean;
+    /** Set position of the attribution
+     * @default 'bottom-right'
+     * @example 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right'
+     */
     attributionPosition?: PanelPosition;
+    /** By default, we render a small attribution in the corner of your flows that links back to the project.
+     *
+     * Anyone is free to remove this attribution whether they're a Pro subscriber or not
+     * but we ask that you take a quick look at our {@link https://reactflow.dev/learn/troubleshooting/remove-attribution | removing attribution guide}
+     * before doing so.
+     */
     proOptions?: ProOptions;
+    /** Enabling this option will raise the z-index of nodes when they are selected.
+     * @default true
+     */
     elevateNodesOnSelect?: boolean;
+    /** Enabling this option will raise the z-index of edges when they are selected.
+     * @default true
+     */
     elevateEdgesOnSelect?: boolean;
+    /**
+     * Can be set true if built-in keyboard controls should be disabled.
+     * @default false
+     */
     disableKeyboardA11y?: boolean;
+    /** You can enable this prop to automatically pan the viewport while dragging a node.
+     * @default true
+     */
     autoPanOnNodeDrag?: boolean;
+    /** You can enable this prop to automatically pan the viewport while dragging a node.
+     * @default true
+     */
     autoPanOnConnect?: boolean;
+    /** You can enable this prop to automatically pan the viewport while making a new connection.
+     * @default true
+     */
     connectionRadius?: number;
+    /** Ocassionally something may happen that causes Svelte Flow to throw an error.
+     *
+     * Instead of exploding your application, we log a message to the console and then call this event handler.
+     * You might use it for additional logging or to show a message to the user.
+     */
     onError?: OnError;
+    /** This callback can be used to validate a new connection
+     *
+     * If you return false, the edge will not be added to your flow.
+     * If you have custom connection logic its preferred to use this callback over the isValidConnection prop on the handle component for performance reasons.
+     * @default (connection: Connection) => true
+     */
     isValidConnection?: IsValidConnection;
+    /** With a threshold greater than zero you can control the distinction between node drag and click events.
+     *
+     * If threshold equals 1, you need to drag the node 1 pixel before a drag event is fired.
+     * @default 1
+     */
     nodeDragThreshold?: number;
+    /** Sets a fixed width for the flow */
     width?: number;
+    /** Sets a fixed height for the flow */
     height?: number;
+    /** Controls color scheme used for styling the flow
+     * @default 'system'
+     * @example 'system' | 'light' | 'dark'
+     */
     colorMode?: ColorMode;
-};
+}
 export type ReactFlowRefType = HTMLDivElement;
 //# sourceMappingURL=component-props.d.ts.map

package/dist/esm/types/component-props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"component-props.d.ts","sourceRoot":"","sources":["../../../../packages/react/src/types/component-props.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,UAAU,IAAI,eAAe,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACtG,OAAO,KAAK,EACV,cAAc,EACd,kBAAkB,EAClB,SAAS,EACT,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,OAAO,EACP,eAAe,EACf,UAAU,EACV,aAAa,EACb,MAAM,EACN,WAAW,EACX,SAAS,EACT,QAAQ,EACR,UAAU,EACV,UAAU,EACV,aAAa,EACb,OAAO,EACP,iBAAiB,EACjB,SAAS,EACT,QAAQ,EACR,cAAc,EACf,MAAM,gBAAgB,CAAC;AAExB,OAAO,KAAK,EACV,qBAAqB,EACrB,SAAS,EACT,SAAS,EACT,IAAI,EACJ,IAAI,EACJ,uBAAuB,EACvB,gBAAgB,EAChB,MAAM,EACN,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,aAAa,EACb,QAAQ,EACR,aAAa,EACb,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,GAAG,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,SAAS,CAAC,GAAG;IAC7E,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC;IACtB,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC;IACtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IACrC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,eAAe,CAAC,EAAE,gBAAgB,CAAC;IACnC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IACrC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,cAAc,CAAC,EAAE,eAAe,CAAC;IACjC,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IAC3D,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IACrC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,eAAe,CAAC,EAAE,gBAAgB,CAAC;IACnC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IACrC,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IACzF,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IAC/F,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,eAAe,CAAC,EAAE,oBAAoB,CAAC;IACvC,mBAAmB,CAAC,EAAE,oBAAoB,CAAC;IAC3C,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IACpD,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IAClD,sBAAsB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,IAAI,CAAC;IACzE,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,mBAAmB,CAAC,EAAE,cAAc,CAAC;IACrC,iBAAiB,CAAC,EAAE,YAAY,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;IAC1C,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;IAC5C,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IAC/C,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,GAAG,UAAU,KAAK,IAAI,CAAC;IAClE,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IACpD,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IACnD,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IACpD,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,mBAAmB,CAAC,EAAE,aAAa,CAAC;IACpC,uBAAuB,CAAC,EAAE,uBAAuB,CAAC;IAClD,4BAA4B,CAAC,EAAE,aAAa,CAAC;IAC7C,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAClC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACtC,qBAAqB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACvC,qBAAqB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACvC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM,EAAE,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,eAAe,CAAC,EAAE,QAAQ,CAAC;IAC3B,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IAChD,eAAe,CAAC,EAAE,gBAAgB,CAAC;IACnC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,mBAAmB,CAAC,EAAE,aAAa,CAAC;IACpC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAAC"}
+{"version":3,"file":"component-props.d.ts","sourceRoot":"","sources":["../../../../packages/react/src/types/component-props.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,UAAU,IAAI,eAAe,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACtG,OAAO,KAAK,EACV,cAAc,EACd,kBAAkB,EAClB,SAAS,EACT,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,OAAO,EACP,eAAe,EACf,UAAU,EACV,aAAa,EACb,MAAM,EACN,WAAW,EACX,SAAS,EACT,QAAQ,EACR,UAAU,EACV,UAAU,EACV,aAAa,EACb,OAAO,EACP,iBAAiB,EACjB,SAAS,EACT,QAAQ,EACT,MAAM,gBAAgB,CAAC;AAExB,OAAO,KAAK,EACV,qBAAqB,EACrB,SAAS,EACT,SAAS,EACT,IAAI,EACJ,IAAI,EACJ,uBAAuB,EACvB,gBAAgB,EAChB,MAAM,EACN,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,aAAa,EACb,QAAQ,EACR,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EAChB,UAAU,EACV,cAAc,EACf,MAAM,GAAG,CAAC;AAEX;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,SAAS,CAAC;IACrF;;;;;;;;;;OAUG;IACH,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf,2DAA2D;IAC3D,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC;IACtB,2DAA2D;IAC3D,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC;IACtB;;;;;;;;;;;;;;;;;;OAkBG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,gEAAgE;IAChE,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,uEAAuE;IACvE,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IACrC,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,0EAA0E;IAC1E,eAAe,CAAC,EAAE,gBAAgB,CAAC;IACnC,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,sEAAsE;IACtE,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IACrC,qEAAqE;IACrE,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,4DAA4D;IAC5D,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,qEAAqE;IACrE,cAAc,CAAC,EAAE,UAAU,CAAC;IAC5B,iEAAiE;IACjE,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;IAC3D,uEAAuE;IACvE,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IACrC,uEAAuE;IACvE,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,2EAA2E;IAC3E,eAAe,CAAC,EAAE,gBAAgB,CAAC;IACnC,uEAAuE;IACvE,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,wEAAwE;IACxE,iBAAiB,CAAC,EAAE,gBAAgB,CAAC;IACrC,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IACzF,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IAC/F,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,4DAA4D;IAC5D,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,4DAA4D;IAC5D,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,oEAAoE;IACpE,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,gFAAgF;IAChF,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,uEAAuE;IACvE,eAAe,CAAC,EAAE,oBAAoB,CAAC;IACvC,gFAAgF;IAChF,mBAAmB,CAAC,EAAE,oBAAoB,CAAC;IAC3C,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IACpD,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IAClD,sBAAsB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,IAAI,CAAC;IACzE;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,kFAAkF;IAClF,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,kFAAkF;IAClF,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,mBAAmB,CAAC,EAAE,cAAc,CAAC;IACrC,iBAAiB,CAAC,EAAE,YAAY,CAAC;IACjC,2EAA2E;IAC3E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6FAA6F;IAC7F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oFAAoF;IACpF,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,uFAAuF;IACvF,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,gGAAgG;IAChG,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;IAC1C,sEAAsE;IACtE,YAAY,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;IAC5C,sEAAsE;IACtE,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IAC/C,4EAA4E;IAC5E,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,GAAG,UAAU,KAAK,IAAI,CAAC;IAClE,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IACpD,oEAAoE;IACpE,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IACnD,gEAAgE;IAChE,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IACpD,mIAAmI;IACnI,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,aAAa,CAAC;IACpC,sDAAsD;IACtD,uBAAuB,CAAC,EAAE,uBAAuB,CAAC;IAClD,mEAAmE;IACnE,4BAA4B,CAAC,EAAE,aAAa,CAAC;IAC7C;;;;OAIG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAClC,wFAAwF;IACxF,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACtC;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACvC;;;;SAIK;IACL,qBAAqB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACvC,sDAAsD;IACtD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM,EAAE,CAAC;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,QAAQ,CAAC;IAC3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,CAAC;IAChD;;;;OAIG;IACH,eAAe,CAAC,EAAE,gBAAgB,CAAC;IACnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;OAIG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,6EAA6E;IAC7E,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,yEAAyE;IACzE,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,oFAAoF;IACpF,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,2DAA2D;IAC3D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,aAAa,CAAC;IACpC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAAC"}

package/dist/esm/types/edges.d.ts

@@ -76,13 +76,24 @@ export type EdgeProps<T = any> = Pick<Edge<T>, 'id' | 'animated' | 'data' | 'sty
  * @public
  */
 export type BaseEdgeProps = EdgeLabelOptions & {
+    /** Unique id of edge */
     id?: string;
+    /** Additional padding where interacting with an edge is still possible */
     interactionWidth?: number;
     className?: string;
+    /** The x position of edge label */
     labelX?: number;
+    /** The y position of edge label */
     labelY?: number;
+    /** Marker at start of edge
+     * @example 'url(#arrow)'
+     */
     markerStart?: string;
+    /** Marker at end of edge
+     * @example 'url(#arrow)'
+     */
     markerEnd?: string;
+    /** SVG path of the edge */
     path: string;
     style?: CSSProperties;
 };

package/dist/esm/types/edges.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"edges.d.ts","sourceRoot":"","sources":["../../../../packages/react/src/types/edges.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,SAAS,EAAE,UAAU,IAAI,eAAe,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACpH,OAAO,KAAK,EACV,QAAQ,EACR,iBAAiB,EACjB,QAAQ,EACR,qBAAqB,EACrB,sBAAsB,EACtB,UAAU,EACV,UAAU,EACV,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,OAAO,EACR,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;AAEpC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,aAAa,CAAC;IAC7B,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,UAAU,CAAC;AAEjD,MAAM,MAAM,WAAW,CAAC,QAAQ,GAAG,GAAG,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAC1D,gBAAgB,GAAG;IACjB,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEJ,KAAK,kBAAkB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG;IAC5C,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,CAAC,EAAE,qBAAqB,CAAC;CACrC,CAAC;AAEF,KAAK,cAAc,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG;IACxC,IAAI,EAAE,SAAS,CAAC;IAChB,WAAW,CAAC,EAAE,iBAAiB,CAAC;CACjC,CAAC;AAEF,KAAK,YAAY,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;AAEzG,MAAM,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;AAE5E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,OAAO,CAAC;IACxB,cAAc,EAAE,OAAO,CAAC;IACxB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,aAAa,CAAC,EAAE,gBAAgB,CAAC;IACjC,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,aAAa,CAAC,EAAE,gBAAgB,CAAC;IACjC,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IACzF,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IAC/F,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;AAE9D,MAAM,MAAM,aAAa,GAAG,cAAc,CAAC,UAAU,CAAC,GACpD,gBAAgB,GAAG;IACjB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,GAAG,GAAG,IAAI,IAAI,CACnC,IAAI,CAAC,CAAC,CAAC,EACP,IAAI,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,CACxE,GACC,YAAY,GACZ,gBAAgB,GAAG;IACjB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,gBAAgB,GAAG;IAC7C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAC3C,gBAAgB,GAAG;IACjB,EAAE,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IACrB,WAAW,CAAC,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,SAAS,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;IACnC,gBAAgB,CAAC,EAAE,SAAS,CAAC,kBAAkB,CAAC,CAAC;IACjD,KAAK,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAC3B,cAAc,CAAC,EAAE,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAC7C,cAAc,CAAC,EAAE,SAAS,CAAC,gBAAgB,CAAC,CAAC;CAC9C,CAAC;AAEJ,MAAM,MAAM,4BAA4B,CAAC,WAAW,IAAI,kBAAkB,GAAG;IAC3E,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,4BAA4B,CAAC,iBAAiB,CAAC,CAAC;AAE9E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,4BAA4B,CAAC,qBAAqB,CAAC,CAAC;AAEtF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,4BAA4B,CAAC,eAAe,CAAC,CAAC;AAE1E;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,EAAE,gBAAgB,GAAG,gBAAgB,CAAC,CAAC;AAE9F;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,CAAC;AAEvD,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,KAAK,IAAI,CAAC;AAE9F,MAAM,MAAM,4BAA4B,GAAG;IACzC,mBAAmB,CAAC,EAAE,aAAa,CAAC;IACpC,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,QAAQ,CAAC;IACvB,UAAU,EAAE,QAAQ,CAAC;IACrB,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,aAAa,CAAC,4BAA4B,CAAC,CAAC"}
+{"version":3,"file":"edges.d.ts","sourceRoot":"","sources":["../../../../packages/react/src/types/edges.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,SAAS,EAAE,UAAU,IAAI,eAAe,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACpH,OAAO,KAAK,EACV,QAAQ,EACR,iBAAiB,EACjB,QAAQ,EACR,qBAAqB,EACrB,sBAAsB,EACtB,UAAU,EACV,UAAU,EACV,kBAAkB,EAClB,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,OAAO,EACR,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;AAEpC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,aAAa,CAAC;IAC7B,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,UAAU,CAAC;AAEjD,MAAM,MAAM,WAAW,CAAC,QAAQ,GAAG,GAAG,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAC1D,gBAAgB,GAAG;IACjB,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEJ,KAAK,kBAAkB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG;IAC5C,IAAI,EAAE,YAAY,CAAC;IACnB,WAAW,CAAC,EAAE,qBAAqB,CAAC;CACrC,CAAC;AAEF,KAAK,cAAc,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG;IACxC,IAAI,EAAE,SAAS,CAAC;IAChB,WAAW,CAAC,EAAE,iBAAiB,CAAC;CACjC,CAAC;AAEF,KAAK,YAAY,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;AAEzG,MAAM,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC;AAE5E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,OAAO,CAAC;IACxB,cAAc,EAAE,OAAO,CAAC;IACxB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,aAAa,CAAC,EAAE,gBAAgB,CAAC;IACjC,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,aAAa,CAAC,EAAE,gBAAgB,CAAC;IACjC,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IACzF,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IAC/F,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,IAAI,CAAC,CAAC;AAE9D,MAAM,MAAM,aAAa,GAAG,cAAc,CAAC,UAAU,CAAC,GACpD,gBAAgB,GAAG;IACjB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,GAAG,GAAG,IAAI,IAAI,CACnC,IAAI,CAAC,CAAC,CAAC,EACP,IAAI,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,CACxE,GACC,YAAY,GACZ,gBAAgB,GAAG;IACjB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,gBAAgB,GAAG;IAC7C,wBAAwB;IACxB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,0EAA0E;IAC1E,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAC3C,gBAAgB,GAAG;IACjB,EAAE,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IACrB,WAAW,CAAC,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;IACvC,SAAS,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;IACnC,gBAAgB,CAAC,EAAE,SAAS,CAAC,kBAAkB,CAAC,CAAC;IACjD,KAAK,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAC3B,cAAc,CAAC,EAAE,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAC7C,cAAc,CAAC,EAAE,SAAS,CAAC,gBAAgB,CAAC,CAAC;CAC9C,CAAC;AAEJ,MAAM,MAAM,4BAA4B,CAAC,WAAW,IAAI,kBAAkB,GAAG;IAC3E,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,4BAA4B,CAAC,iBAAiB,CAAC,CAAC;AAE9E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,4BAA4B,CAAC,qBAAqB,CAAC,CAAC;AAEtF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,4BAA4B,CAAC,eAAe,CAAC,CAAC;AAE1E;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,EAAE,gBAAgB,GAAG,gBAAgB,CAAC,CAAC;AAE9F;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,CAAC;AAEvD,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,KAAK,IAAI,CAAC;AAE9F,MAAM,MAAM,4BAA4B,GAAG;IACzC,mBAAmB,CAAC,EAAE,aAAa,CAAC;IACpC,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,QAAQ,CAAC;IACvB,UAAU,EAAE,QAAQ,CAAC;IACrB,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,aAAa,CAAC,4BAA4B,CAAC,CAAC"}

package/dist/esm/types/general.d.ts

@@ -1,9 +1,9 @@
-import { FitViewParamsBase, FitViewOptionsBase, ZoomInOut, ZoomTo, SetViewport, GetZoom, GetViewport, SetCenter, FitBounds, XYPosition, NodeProps } from '@xyflow/system';
+import { FitViewParamsBase, FitViewOptionsBase, ZoomInOut, ZoomTo, SetViewport, GetZoom, GetViewport, SetCenter, FitBounds, XYPosition, NodeProps, OnBeforeDeleteBase } from '@xyflow/system';
 import type { NodeChange, EdgeChange, Node, Edge, ReactFlowInstance, EdgeProps } from '.';
 import { ComponentType } from 'react';
-export type OnNodesChange = (changes: NodeChange[]) => void;
-export type OnEdgesChange = (changes: EdgeChange[]) => void;
-export type OnNodesDelete = (nodes: Node[]) => void;
+export type OnNodesChange<NodeType extends Node = Node> = (changes: NodeChange<NodeType>[]) => void;
+export type OnEdgesChange<EdgeType extends Edge = Edge> = (changes: EdgeChange<EdgeType>[]) => void;
+export type OnNodesDelete<NodeType extends Node = Node> = (nodes: NodeType[]) => void;
 export type OnEdgesDelete = (edges: Edge[]) => void;
 export type OnDelete = (params: {
     nodes: Node[];
@@ -29,17 +29,94 @@ export type FitViewOptions = FitViewOptionsBase<Node>;
 export type FitView = (fitViewOptions?: FitViewOptions) => boolean;
 export type OnInit<NodeType extends Node = Node, EdgeType extends Edge = Edge> = (reactFlowInstance: ReactFlowInstance<NodeType, EdgeType>) => void;
 export type ViewportHelperFunctions = {
+    /**
+     * Zooms viewport in by 1.2.
+     *
+     * @param options.duration - optional duration. If set, a transition will be applied
+     */
     zoomIn: ZoomInOut;
+    /**
+     * Zooms viewport out by 1 / 1.2.
+     *
+     * @param options.duration - optional duration. If set, a transition will be applied
+     */
     zoomOut: ZoomInOut;
+    /**
+     * Sets the current zoom level.
+     *
+     * @param zoomLevel - the zoom level to set
+     * @param options.duration - optional duration. If set, a transition will be applied
+     */
     zoomTo: ZoomTo;
+    /**
+     * Returns the current zoom level.
+     *
+     * @returns current zoom as a number
+     */
     getZoom: GetZoom;
+    /**
+     * Sets the current viewport.
+     *
+     * @param viewport - the viewport to set
+     * @param options.duration - optional duration. If set, a transition will be applied
+     */
     setViewport: SetViewport;
+    /**
+     * Returns the current viewport.
+     *
+     * @returns Viewport
+     */
     getViewport: GetViewport;
+    /**
+     * Fits the view.
+     *
+     * @param options.padding - optional padding
+     * @param options.includeHiddenNodes - optional includeHiddenNodes
+     * @param options.minZoom - optional minZoom
+     * @param options.maxZoom - optional maxZoom
+     * @param options.duration - optional duration. If set, a transition will be applied
+     * @param options.nodes - optional nodes to fit the view to
+     */
     fitView: FitView;
+    /**
+     * Sets the center of the view to the given position.
+     *
+     * @param x - x position
+     * @param y - y position
+     * @param options.zoom - optional zoom
+     */
     setCenter: SetCenter;
+    /**
+     * Fits the view to the given bounds .
+     *
+     * @param bounds - the bounds ({ x: number, y: number, width: number, height: number }) to fit the view to
+     * @param options.padding - optional padding
+     */
     fitBounds: FitBounds;
-    screenToFlowPosition: (position: XYPosition) => XYPosition;
-    flowToScreenPosition: (position: XYPosition) => XYPosition;
+    /**
+     * Converts a screen / client position to a flow position.
+     *
+     * @param clientPosition - the screen / client position. When you are working with events you can use event.clientX and event.clientY
+     * @param options.snapToGrid - if true, the converted position will be snapped to the grid
+     * @returns position as { x: number, y: number }
+     *
+     * @example
+     * const flowPosition = screenToFlowPosition({ x: event.clientX, y: event.clientY })
+     */
+    screenToFlowPosition: (clientPosition: XYPosition, options?: {
+        snapToGrid: boolean;
+    }) => XYPosition;
+    /**
+     * Converts a flow position to a screen / client position.
+     *
+     * @param flowPosition - the screen / client position. When you are working with events you can use event.clientX and event.clientY
+     * @returns position as { x: number, y: number }
+     *
+     * @example
+     * const clientPosition = flowToScreenPosition({ x: node.position.x, y: node.position.y })
+     */
+    flowToScreenPosition: (flowPosition: XYPosition) => XYPosition;
     viewportInitialized: boolean;
 };
+export type OnBeforeDelete<NodeType extends Node = Node, EdgeType extends Edge = Edge> = OnBeforeDeleteBase<NodeType, EdgeType>;
 //# sourceMappingURL=general.d.ts.map