@stealthscale/component-graphs 0.2.1 → 0.2.2
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.
- package/dist/cyclonedx/bom.json +1 -1
- package/dist/index.js +1 -3807
- package/dist/pages/directed-graph/directed-graph.js +1170 -0
- package/dist/pages/directed-graph/directed-graph.props.js +3 -0
- package/dist/pages/graph/graph.js +1619 -0
- package/dist/pages/graph/graph.props.js +3 -0
- package/dist/pages/network-graph/network-graph.js +1542 -0
- package/dist/pages/network-graph/network-graph.props.js +3 -0
- package/dist/pages/pages.json +43 -0
- package/dist/shared-DOF4V8-Q.js +3808 -0
- package/dist/theme.js +1 -1
- package/locales/en/specimen/directed-graph.json +88 -0
- package/locales/en/specimen/graph.json +155 -0
- package/locales/en/specimen/network-graph.json +99 -0
- package/package.json +8 -7
- /package/dist/{recipe-lWPA4IJC.js → recipes-lWPA4IJC.js} +0 -0
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export const dropped = {"NetworkGraphProps": {"conditions": 284, "foreign": 1038}, "CanvasProps": {"conditions": 0, "foreign": 273}, "CaptionProps": {"conditions": 284, "foreign": 1041}, "ControlProps": {"conditions": 284, "foreign": 1036}, "ControlsProps": {"conditions": 284, "foreign": 1038}, "EmptyProps": {"conditions": 284, "foreign": 1041}, "MiniMapProps": {"conditions": 0, "foreign": 277}, "NodeProps": {"conditions": 0, "foreign": 0}, "PaletteItemProps": {"conditions": 284, "foreign": 1048}, "RootProps": {"conditions": 284, "foreign": 1040}, "SummaryProps": {"conditions": 284, "foreign": 1041}, "ZoomLevelProps": {"conditions": 284, "foreign": 1043}};
|
|
2
|
+
export const parts = {"NetworkGraphProps": [{"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "caption", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "The finding in words, which names the figure."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "clearLabel", "refers": [], "required": false, "says": "Words of the control that drops the focus. `Clear focus` unless stated."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "controls", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Toolbar above the canvas, such as `Graph.Controls` with the caller's glyphs."}, {"accepts": "string | null", "fallback": "", "kind": "option", "name": "defaultFocus", "refers": [], "required": false, "says": "Node focused on the first render, or `null` for none."}, {"accepts": "number", "fallback": "", "kind": "option", "name": "depth", "refers": [], "required": false, "says": "Number of hops from the focused node within which a node is lit. 1 unless stated."}, {"accepts": "boolean", "fallback": "", "kind": "option", "name": "draggable", "refers": [], "required": false, "says": "Whether a person can move a node by dragging it or by the arrow keys. On unless stated."}, {"accepts": "((ends: EdgeEnds) => string)", "fallback": "", "kind": "option", "name": "edgeName", "refers": ["kit.EdgeEnds"], "required": false, "says": "Writes the name of a link from the names of its ends. `Orders and Billing` unless stated."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "emptyLabel", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Message in the canvas's place while the graph has no node. `No nodes to show.` unless stated."}, {"accepts": "string | null", "fallback": "", "kind": "option", "name": "focus", "refers": [], "required": false, "says": "Focused node, controlled, or `null` for none."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "focusLabel", "refers": [], "required": false, "says": "Word the focused node's accessible name ends with. `Focus` unless stated."}, {"accepts": "number", "fallback": "", "kind": "option", "name": "iterations", "refers": [], "required": false, "says": "Number of the layout's steps. 300 unless stated."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "label", "refers": [], "required": true, "says": "Accessible name of the canvas."}, {"accepts": "readonly NetworkLink[]", "fallback": "", "kind": "option", "name": "links", "refers": ["kit.NetworkLink"], "required": true, "says": "Links of the graph, read the same either way round."}, {"accepts": "((move: Move) => string)", "fallback": "", "kind": "option", "name": "moveAnnouncement", "refers": ["kit.Move"], "required": false, "says": "Writes the announcement of a move the arrow keys make."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "neighborLabel", "refers": [], "required": false, "says": "Word the accessible name of a node the focused node connects to ends with. `Connected` unless stated."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "nodeDescription", "refers": [], "required": false, "says": "Instruction every node is described by for a screen reader, which offers Enter, Space, Escape and, while nodes can be dragged, the arrow keys unless stated."}, {"accepts": "readonly NetworkNode[]", "fallback": "", "kind": "option", "name": "nodes", "refers": ["kit.NetworkNode", "react.ReactElement", "react.ReactPortal"], "required": true, "says": "Nodes of the graph, in any order."}, {"accepts": "((id: string | null) => void)", "fallback": "", "kind": "option", "name": "onFocusChange", "refers": [], "required": false, "says": "Called with the focused node's id, or `null` when the focus is dropped."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "overview", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Overview map below the canvas, such as `Graph.MiniMap`."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "promptLabel", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Words of the summary while nothing is focused."}, {"accepts": "Ratio", "fallback": "", "kind": "variant", "name": "ratio", "refers": ["kit.Ratio"], "required": false, "says": "Aspect ratio of the canvas, one of the theme's ratios, which the empty state takes in the canvas's place."}, {"accepts": "number", "fallback": "", "kind": "option", "name": "seed", "refers": [], "required": false, "says": "Number the layout starts from. The same seed and graph give the same picture. 1 unless stated."}, {"accepts": "((connections: Connections) => ReactNode)", "fallback": "", "kind": "option", "name": "summary", "refers": ["kit.Connections"], "required": false, "says": "Writes the summary of a focus. `Orders: 3 connections` unless stated."}], "CanvasProps": [{"accepts": "string", "fallback": "", "kind": "option", "name": "addedLabel", "refers": [], "required": false, "says": "Word of an added node or edge. `Added` unless stated."}, {"accepts": "PanelPosition", "fallback": "'bottom-right'", "kind": "option", "name": "attributionPosition", "refers": ["system.PanelPosition"], "required": false, "says": "By default, React Flow will render a small attribution in the bottom right corner of the flow."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "autoPanOnConnect", "refers": [], "required": false, "says": "When `true`, the viewport will pan automatically when the cursor moves to the edge of the viewport while creating a connection."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "autoPanOnNodeDrag", "refers": [], "required": false, "says": "When `true`, the viewport will pan automatically when the cursor moves to the edge of the viewport while dragging a node."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "autoPanOnNodeFocus", "refers": [], "required": false, "says": "When `true`, the viewport will pan when a node is focused."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "autoPanOnSelection", "refers": [], "required": false, "says": "When `true`, the viewport will pan automatically when the cursor moves to the edge of the viewport while creating a selection box."}, {"accepts": "number", "fallback": "15", "kind": "option", "name": "autoPanSpeed", "refers": [], "required": false, "says": "The speed at which the viewport pans while dragging a node or a selection box."}, {"accepts": "boolean", "fallback": "", "kind": "option", "name": "background", "refers": [], "required": false, "says": "Whether the canvas renders its dotted background. On unless stated."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "changedLabel", "refers": [], "required": false, "says": "Word of a changed node. `Changed` unless stated."}, {"accepts": "GraphDiff", "fallback": "", "kind": "option", "name": "changes", "refers": ["kit.GraphChange", "kit.GraphDiff"], "required": false, "says": "Comparison whose changes the canvas marks, such as `diffGraphs(before, after)`."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "children", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Elements React Flow renders over the canvas, such as a panel of the caller's. The kit's controls and overview map go beside the canvas, in `Graph.Root`."}, {"accepts": "number", "fallback": "1", "kind": "option", "name": "connectionDragThreshold", "refers": [], "required": false, "says": "The threshold in pixels that the mouse must move before a connection line starts to drag. This is useful to prevent accidental connections when clicking on a handle."}, {"accepts": "ConnectionLineComponent<N>", "fallback": "", "kind": "option", "name": "connectionLineComponent", "refers": ["kit.N", "react.CSSProperties", "react.ComponentClass", "react.ConnectionLineComponent", "react.ConnectionLineComponentProps", "react.Consumer", "react.Context", "react.FunctionComponent", "react.GetDerivedStateFromError", "react.GetDerivedStateFromProps", "react.Provider", "react.ProviderProps", "system.Bezier", "system.Bottom", "system.ConnectionLineType", "system.Handle", "system.Left", "system.Position", "system.Right", "system.SimpleBezier", "system.SmoothStep", "system.Step", "system.Straight", "system.Top", "system.XYPosition"], "required": false, "says": "React Component to be used as a connection line."}, {"accepts": "CSSProperties", "fallback": "", "kind": "option", "name": "connectionLineContainerStyle", "refers": ["react.CSSProperties"], "required": false, "says": "Styles to be applied to the container of the connection line."}, {"accepts": "CSSProperties", "fallback": "", "kind": "option", "name": "connectionLineStyle", "refers": ["react.CSSProperties"], "required": false, "says": "Styles to be applied to the connection line."}, {"accepts": "ConnectionLineType", "fallback": "ConnectionLineType.Bezier", "kind": "option", "name": "connectionLineType", "refers": ["system.Bezier", "system.ConnectionLineType", "system.SimpleBezier", "system.SmoothStep", "system.Step", "system.Straight"], "required": false, "says": "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!"}, {"accepts": "ConnectionMode", "fallback": "'strict'", "kind": "option", "name": "connectionMode", "refers": ["system.ConnectionMode", "system.Loose", "system.Strict"], "required": false, "says": "A loose connection mode will allow you to connect handles with differing types, including source-to-source connections. However, it does not support target-to-target connections. Strict mode allows only connections between source handles and target handles."}, {"accepts": "number", "fallback": "20", "kind": "option", "name": "connectionRadius", "refers": [], "required": false, "says": "The radius around a handle where you drop a connection line to create a new edge."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "connectOnClick", "refers": [], "required": false, "says": "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."}, {"accepts": "boolean", "fallback": "false", "kind": "option", "name": "debug", "refers": [], "required": false, "says": "If set `true`, some debug information will be logged to the console like which events are fired."}, {"accepts": "DefaultEdgeOptions", "fallback": "", "kind": "option", "name": "defaultEdgeOptions", "refers": ["react.AriaRole", "react.CSSProperties", "react.DefaultEdgeOptions", "react.ReactElement", "react.ReactPortal", "react.SVGAttributes", "system.Arrow", "system.ArrowClosed", "system.EdgeMarker", "system.EdgeMarkerType"], "required": false, "says": "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."}, {"accepts": "E[]", "fallback": "", "kind": "option", "name": "defaultEdges", "refers": ["kit.E"], "required": false, "says": "The initial edges to render in an uncontrolled flow."}, {"accepts": "string | null", "fallback": "'#b1b1b7'", "kind": "option", "name": "defaultMarkerColor", "refers": [], "required": false, "says": "Color of edge markers. You can pass `null` to use the CSS variable `--xy-edge-stroke` for the marker color."}, {"accepts": "N[]", "fallback": "", "kind": "option", "name": "defaultNodes", "refers": ["kit.N"], "required": false, "says": "The initial nodes to render in an uncontrolled flow."}, {"accepts": "Viewport", "fallback": "{ x: 0, y: 0, zoom: 1 }", "kind": "option", "name": "defaultViewport", "refers": ["system.Viewport"], "required": false, "says": "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."}, {"accepts": "KeyCode | null", "fallback": "'Backspace'", "kind": "option", "name": "deleteKeyCode", "refers": ["system.KeyCode"], "required": false, "says": "If set, pressing the key or chord will delete any selected nodes and edges. Passing an array represents multiple keys that can be pressed."}, {"accepts": "boolean", "fallback": "false", "kind": "option", "name": "disableKeyboardA11y", "refers": [], "required": false, "says": "You can use this prop to disable keyboard accessibility features such as selecting nodes or moving selected nodes with the arrow keys."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "edgeDescription", "refers": [], "required": false, "says": "Instruction every edge of an editable canvas is described by."}, {"accepts": "((ends: EdgeEnds) => string)", "fallback": "", "kind": "option", "name": "edgeName", "refers": ["kit.EdgeEnds"], "required": false, "says": "Writes the name of an edge without a name of its own from the names of its ends. `Orders to Clean orders` unless stated."}, {"accepts": "E[]", "fallback": "[]", "kind": "option", "name": "edges", "refers": ["kit.E"], "required": false, "says": "An array of edges to render in a controlled flow."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "edgesFocusable", "refers": [], "required": false, "says": "When `true`, focus between edges can be cycled with the `Tab` key and selected with the `Enter` key. This option can be overridden by individual edges by setting their `focusable` prop."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "edgesReconnectable", "refers": [], "required": false, "says": "Whether edges can be updated once they are created. When both this prop is `true` and an `onReconnect` handler is provided, the user can drag an existing edge to a new source or target. Individual edges can override this value with their reconnectable property."}, {"accepts": "EdgeTypes", "fallback": "{\ndefault: BezierEdge,\nstraight: StraightEdge,\nstep: StepEdge,\nsmoothstep: SmoothStepEdge,\nsimplebezier: SimpleBezier\n}", "kind": "option", "name": "edgeTypes", "refers": ["react.EdgeTypes"], "required": false, "says": "Custom edge types to be available in a flow. React Flow matches an edge's type to a component in the `edgeTypes` object."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "elementsSelectable", "refers": [], "required": false, "says": "When `true`, elements (nodes and edges) can be selected by clicking on them. This option can be overridden by individual elements by setting their `selectable` prop."}, {"accepts": "boolean", "fallback": "false", "kind": "option", "name": "elevateEdgesOnSelect", "refers": [], "required": false, "says": "Enabling this option will raise the z-index of edges when they are selected."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "elevateNodesOnSelect", "refers": [], "required": false, "says": "Enabling this option will raise the z-index of nodes when they are selected."}, {"accepts": "boolean", "fallback": "", "kind": "option", "name": "fitView", "refers": [], "required": false, "says": "When `true`, the flow will be zoomed and panned to fit all the nodes initially provided."}, {"accepts": "FitViewOptions", "fallback": "", "kind": "option", "name": "fitViewOptions", "refers": ["react.FitViewOptions", "system.Padding"], "required": false, "says": "When you typically call `fitView` on a `ReactFlowInstance`, you can provide an object of options to customize its behavior. This prop lets you do the same for the initial `fitView` call."}, {"accepts": "number", "fallback": "", "kind": "option", "name": "height", "refers": [], "required": false, "says": "Sets a fixed height for the flow."}, {"accepts": "IsValidConnection<E>", "fallback": "", "kind": "option", "name": "isValidConnection", "refers": ["kit.E", "react.IsValidConnection", "system.Connection"], "required": false, "says": "This callback can be used to validate a new connection"}, {"accepts": "string", "fallback": "", "kind": "option", "name": "label", "refers": [], "required": true, "says": "Accessible name of the canvas."}, {"accepts": "number", "fallback": "2", "kind": "option", "name": "maxZoom", "refers": [], "required": false, "says": "Maximum zoom level."}, {"accepts": "number", "fallback": "0.5", "kind": "option", "name": "minZoom", "refers": [], "required": false, "says": "Minimum zoom level."}, {"accepts": "((move: Move) => string)", "fallback": "", "kind": "option", "name": "moveAnnouncement", "refers": ["kit.Move"], "required": false, "says": "Writes the announcement of a move the arrow keys make."}, {"accepts": "KeyCode | null", "fallback": "\"Meta\" for macOS, \"Control\" for other systems", "kind": "option", "name": "multiSelectionKeyCode", "refers": ["system.KeyCode"], "required": false, "says": "Pressing down this key you can select multiple elements by clicking."}, {"accepts": "number", "fallback": "0", "kind": "option", "name": "nodeClickDistance", "refers": [], "required": false, "says": "Distance that the mouse can move between mousedown/up that will trigger a click."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "nodeDescription", "refers": [], "required": false, "says": "Instruction every node of an editable canvas is described by."}, {"accepts": "number", "fallback": "1", "kind": "option", "name": "nodeDragThreshold", "refers": [], "required": false, "says": "With a threshold greater than zero you can delay node drag events. If threshold equals 1, you need to drag the node 1 pixel before a drag event is fired. 1 is the default value, so that clicks don't trigger drag events."}, {"accepts": "CoordinateExtent", "fallback": "", "kind": "option", "name": "nodeExtent", "refers": ["system.CoordinateExtent"], "required": false, "says": "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."}, {"accepts": "NodeOrigin", "fallback": "[0, 0]", "kind": "option", "name": "nodeOrigin", "refers": ["system.NodeOrigin"], "required": false, "says": "The origin of the node to use when placing it in the flow or looking up its `x` and `y` position. An origin of `[0, 0]` means that a node's top left corner will be placed at the `x` and `y` position."}, {"accepts": "N[]", "fallback": "[]", "kind": "option", "name": "nodes", "refers": ["kit.N"], "required": false, "says": "An array of nodes to render in a controlled flow."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "nodesConnectable", "refers": [], "required": false, "says": "Controls whether all nodes should be connectable or not. Individual nodes can override this setting by setting their `connectable` prop."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "nodesDraggable", "refers": [], "required": false, "says": "Controls whether all nodes should be draggable or not. Individual nodes can override this setting by setting their `draggable` prop. If you want to use the mouse handlers on non-draggable nodes, you need to add the `\"nopan\"` class to those nodes."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "nodesFocusable", "refers": [], "required": false, "says": "When `true`, focus between nodes can be cycled with the `Tab` key and selected with the `Enter` key. This option can be overridden by individual nodes by setting their `focusable` prop."}, {"accepts": "NodeTypes", "fallback": "{\ninput: InputNode,\ndefault: DefaultNode,\noutput: OutputNode,\ngroup: GroupNode\n}", "kind": "option", "name": "nodeTypes", "refers": ["react.NodeTypes"], "required": false, "says": "Custom node types to be available in a flow. React Flow matches a node's type to a component in the `nodeTypes` object."}, {"accepts": "string", "fallback": "\"nodrag\"", "kind": "option", "name": "noDragClassName", "refers": [], "required": false, "says": "If a node is draggable, clicking and dragging that node will move it around the canvas. Adding the `\"nodrag\"` class prevents this behavior and this prop allows you to change the name of that class."}, {"accepts": "string", "fallback": "\"nopan\"", "kind": "option", "name": "noPanClassName", "refers": [], "required": false, "says": "If an element in the canvas does not stop mouse events from propagating, clicking and dragging that element will pan the viewport. Adding the `\"nopan\"` class prevents this behavior and this prop allows you to change the name of that class."}, {"accepts": "string", "fallback": "\"nowheel\"", "kind": "option", "name": "noWheelClassName", "refers": [], "required": false, "says": "Typically, scrolling the mouse wheel when the mouse is over the canvas will zoom the viewport. Adding the `\"nowheel\"` class to an element in the canvas will prevent this behavior and this prop allows you to change the name of that class."}, {"accepts": "OnBeforeDelete<N, E>", "fallback": "", "kind": "option", "name": "onBeforeDelete", "refers": ["kit.E", "kit.N", "react.OnBeforeDelete"], "required": false, "says": "This handler is called before nodes or edges are deleted, allowing the deletion to be aborted by returning `false` or modified by returning updated nodes and edges."}, {"accepts": "OnConnectEnd", "fallback": "", "kind": "option", "name": "onClickConnectEnd", "refers": ["system.ConnectionInProgress", "system.FinalConnectionState", "system.NoConnection", "system.OnConnectEnd"], "required": false, "says": ""}, {"accepts": "OnConnectStart", "fallback": "", "kind": "option", "name": "onClickConnectStart", "refers": ["system.OnConnectStart", "system.OnConnectStartParams"], "required": false, "says": ""}, {"accepts": "OnConnect", "fallback": "", "kind": "option", "name": "onConnect", "refers": ["system.Connection", "system.OnConnect"], "required": false, "says": "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."}, {"accepts": "OnConnectEnd", "fallback": "", "kind": "option", "name": "onConnectEnd", "refers": ["system.ConnectionInProgress", "system.FinalConnectionState", "system.NoConnection", "system.OnConnectEnd"], "required": false, "says": "This callback will fire regardless of whether a valid connection could be made or not. You can use the second `connectionState` parameter to have different behavior when a connection was unsuccessful."}, {"accepts": "OnConnectStart", "fallback": "", "kind": "option", "name": "onConnectStart", "refers": ["system.HandleType", "system.OnConnectStart", "system.OnConnectStartParams"], "required": false, "says": "This event handler gets called when a user starts to drag a connection line."}, {"accepts": "OnDelete<N, E>", "fallback": "", "kind": "option", "name": "onDelete", "refers": ["kit.E", "kit.N", "react.OnDelete"], "required": false, "says": "This event handler gets called when a node or edge is deleted."}, {"accepts": "((item: string, position: XYPosition) => void)", "fallback": "", "kind": "option", "name": "onDropItem", "refers": ["system.XYPosition"], "required": false, "says": "Called with a palette item's id and the point in the graph a person dropped it at."}, {"accepts": "((event: MouseEvent<Element, MouseEvent>, edge: E) => void)", "fallback": "", "kind": "option", "name": "onEdgeClick", "refers": ["kit.E", "react.MouseEvent"], "required": false, "says": "This event handler is called when a user clicks on an edge."}, {"accepts": "EdgeMouseHandler<E>", "fallback": "", "kind": "option", "name": "onEdgeContextMenu", "refers": ["kit.E", "react.EdgeMouseHandler", "react.MouseEvent"], "required": false, "says": "This event handler is called when a user right-clicks on an edge."}, {"accepts": "EdgeMouseHandler<E>", "fallback": "", "kind": "option", "name": "onEdgeDoubleClick", "refers": ["kit.E", "react.EdgeMouseHandler", "react.MouseEvent"], "required": false, "says": "This event handler is called when a user double-clicks on an edge."}, {"accepts": "EdgeMouseHandler<E>", "fallback": "", "kind": "option", "name": "onEdgeMouseEnter", "refers": ["kit.E", "react.EdgeMouseHandler", "react.MouseEvent"], "required": false, "says": "This event handler is called when mouse of a user enters an edge."}, {"accepts": "EdgeMouseHandler<E>", "fallback": "", "kind": "option", "name": "onEdgeMouseLeave", "refers": ["kit.E", "react.EdgeMouseHandler", "react.MouseEvent"], "required": false, "says": "This event handler is called when mouse of a user leaves an edge."}, {"accepts": "EdgeMouseHandler<E>", "fallback": "", "kind": "option", "name": "onEdgeMouseMove", "refers": ["kit.E", "react.EdgeMouseHandler", "react.MouseEvent"], "required": false, "says": "This event handler is called when mouse of a user moves over an edge."}, {"accepts": "OnEdgesChange<E>", "fallback": "", "kind": "option", "name": "onEdgesChange", "refers": ["kit.E", "react.OnEdgesChange", "system.EdgeAddChange", "system.EdgeChange", "system.EdgeReplaceChange", "system.NodeRemoveChange", "system.NodeSelectionChange"], "required": false, "says": "Use this event handler to add interactivity to a controlled flow. It is called on edge select and remove."}, {"accepts": "OnEdgesDelete<E>", "fallback": "", "kind": "option", "name": "onEdgesDelete", "refers": ["kit.E", "react.OnEdgesDelete"], "required": false, "says": "This event handler gets called when an edge is deleted."}, {"accepts": "OnError", "fallback": "", "kind": "option", "name": "onError", "refers": ["system.OnError"], "required": false, "says": "Occasionally something may happen that causes React Flow to throw an error."}, {"accepts": "((graph: GraphEdit<N, E>, step: GraphStep) => void)", "fallback": "", "kind": "option", "name": "onGraphChange", "refers": ["kit.E", "kit.GraphEdit", "kit.GraphStep", "kit.GraphStepType", "kit.N"], "required": false, "says": "Channel every edit on the canvas arrives through, as the graph after it and a step, while the canvas's `nodes` and `edges` are the caller's."}, {"accepts": "OnInit<N, E>", "fallback": "", "kind": "option", "name": "onInit", "refers": ["kit.E", "kit.N", "react.FitView", "react.GeneralHelpers", "react.OnInit", "react.ViewportHelperFunctions", "system.FitBounds", "system.GetViewport", "system.GetZoom", "system.SetCenter", "system.SetViewport", "system.ZoomInOut", "system.ZoomTo"], "required": false, "says": "The `onInit` callback is called when the viewport is initialized. At this point you can use the instance to call methods like `fitView` or `zoomTo`."}, {"accepts": "boolean", "fallback": "false", "kind": "option", "name": "onlyRenderVisibleElements", "refers": [], "required": false, "says": "You can enable this optimisation to instruct React Flow to only render nodes and edges that would be visible in the viewport."}, {"accepts": "OnMove", "fallback": "", "kind": "option", "name": "onMove", "refers": ["system.OnMove", "system.Viewport"], "required": false, "says": "This event handler is called while the user is either panning or zooming the viewport."}, {"accepts": "OnMove", "fallback": "", "kind": "option", "name": "onMoveEnd", "refers": ["system.OnMove", "system.Viewport"], "required": false, "says": "This event handler is called when panning or zooming viewport movement stops. If the movement is not user-initiated, the event parameter will be `null`."}, {"accepts": "OnMove", "fallback": "", "kind": "option", "name": "onMoveStart", "refers": ["system.OnMove", "system.Viewport"], "required": false, "says": "This event handler is called when the user begins to pan or zoom the viewport."}, {"accepts": "NodeMouseHandler<N>", "fallback": "", "kind": "option", "name": "onNodeClick", "refers": ["kit.N", "react.MouseEvent", "react.NodeMouseHandler"], "required": false, "says": "This event handler is called when a user clicks on a node."}, {"accepts": "NodeMouseHandler<N>", "fallback": "", "kind": "option", "name": "onNodeContextMenu", "refers": ["kit.N", "react.MouseEvent", "react.NodeMouseHandler"], "required": false, "says": "This event handler is called when a user right-clicks on a node."}, {"accepts": "NodeMouseHandler<N>", "fallback": "", "kind": "option", "name": "onNodeDoubleClick", "refers": ["kit.N", "react.MouseEvent", "react.NodeMouseHandler"], "required": false, "says": "This event handler is called when a user double-clicks on a node."}, {"accepts": "OnNodeDrag<N>", "fallback": "", "kind": "option", "name": "onNodeDrag", "refers": ["kit.N", "react.OnNodeDrag"], "required": false, "says": "This event handler is called when a user drags a node."}, {"accepts": "OnNodeDrag<N>", "fallback": "", "kind": "option", "name": "onNodeDragStart", "refers": ["kit.N", "react.OnNodeDrag"], "required": false, "says": "This event handler is called when a user starts to drag a node."}, {"accepts": "OnNodeDrag<N>", "fallback": "", "kind": "option", "name": "onNodeDragStop", "refers": ["kit.N", "react.OnNodeDrag"], "required": false, "says": "This event handler is called when a user stops dragging a node."}, {"accepts": "NodeMouseHandler<N>", "fallback": "", "kind": "option", "name": "onNodeMouseEnter", "refers": ["kit.N", "react.MouseEvent", "react.NodeMouseHandler"], "required": false, "says": "This event handler is called when mouse of a user enters a node."}, {"accepts": "NodeMouseHandler<N>", "fallback": "", "kind": "option", "name": "onNodeMouseLeave", "refers": ["kit.N", "react.MouseEvent", "react.NodeMouseHandler"], "required": false, "says": "This event handler is called when mouse of a user leaves a node."}, {"accepts": "NodeMouseHandler<N>", "fallback": "", "kind": "option", "name": "onNodeMouseMove", "refers": ["kit.N", "react.MouseEvent", "react.NodeMouseHandler"], "required": false, "says": "This event handler is called when mouse of a user moves over a node."}, {"accepts": "OnNodesChange<N>", "fallback": "", "kind": "option", "name": "onNodesChange", "refers": ["kit.N", "react.OnNodesChange", "system.NodeAddChange", "system.NodeChange", "system.NodeDimensionChange", "system.NodePositionChange", "system.NodeRemoveChange", "system.NodeReplaceChange", "system.NodeSelectionChange"], "required": false, "says": "Use this event handler to add interactivity to a controlled flow. It is called on node drag, select, and move."}, {"accepts": "OnNodesDelete<N>", "fallback": "", "kind": "option", "name": "onNodesDelete", "refers": ["kit.N", "react.OnNodesDelete"], "required": false, "says": "This event handler gets called when a node is deleted."}, {"accepts": "((event: MouseEvent<Element, MouseEvent>) => void)", "fallback": "", "kind": "option", "name": "onPaneClick", "refers": ["react.MouseEvent"], "required": false, "says": "This event handler gets called when user clicks inside the pane."}, {"accepts": "((event: MouseEvent | React.MouseEvent<Element, MouseEvent>) => void)", "fallback": "", "kind": "option", "name": "onPaneContextMenu", "refers": ["react.MouseEvent"], "required": false, "says": "This event handler gets called when user right clicks inside the pane."}, {"accepts": "((event: MouseEvent<Element, MouseEvent>) => void)", "fallback": "", "kind": "option", "name": "onPaneMouseEnter", "refers": ["react.MouseEvent"], "required": false, "says": "This event handler gets called when mouse enters the pane."}, {"accepts": "((event: MouseEvent<Element, MouseEvent>) => void)", "fallback": "", "kind": "option", "name": "onPaneMouseLeave", "refers": ["react.MouseEvent"], "required": false, "says": "This event handler gets called when mouse leaves the pane."}, {"accepts": "((event: MouseEvent<Element, MouseEvent>) => void)", "fallback": "", "kind": "option", "name": "onPaneMouseMove", "refers": ["react.MouseEvent"], "required": false, "says": "This event handler gets called when mouse moves over the pane."}, {"accepts": "((event?: WheelEvent<Element>) => void)", "fallback": "", "kind": "option", "name": "onPaneScroll", "refers": ["react.WheelEvent"], "required": false, "says": "This event handler gets called when user scroll inside the pane."}, {"accepts": "OnReconnect<E>", "fallback": "", "kind": "option", "name": "onReconnect", "refers": ["kit.E", "system.Connection", "system.OnReconnect"], "required": false, "says": "This handler is called when the source or target of a reconnectable edge is dragged from the current node. It will fire even if the edge's source or target do not end up changing. You can use the `reconnectEdge` utility to convert the connection to a new edge."}, {"accepts": "((event: MouseEvent | TouchEvent, edge: E, handleType: HandleType, connectionState: FinalConnectionState) => void)", "fallback": "", "kind": "option", "name": "onReconnectEnd", "refers": ["kit.E", "system.ConnectionInProgress", "system.FinalConnectionState", "system.HandleType", "system.NoConnection"], "required": false, "says": "This event fires when the user releases the source or target of an editable edge. It is called even if an edge update does not occur."}, {"accepts": "((event: MouseEvent<Element, MouseEvent>, edge: E, handleType: HandleType) => void)", "fallback": "", "kind": "option", "name": "onReconnectStart", "refers": ["kit.E", "react.MouseEvent", "system.HandleType"], "required": false, "says": "This event fires when the user begins dragging the source or target of an editable edge."}, {"accepts": "OnSelectionChangeFunc<N, E>", "fallback": "", "kind": "option", "name": "onSelectionChange", "refers": ["kit.E", "kit.N", "react.OnSelectionChangeFunc", "react.OnSelectionChangeParams"], "required": false, "says": "This event handler gets called when a user changes group of selected elements in the flow."}, {"accepts": "((event: MouseEvent<Element, MouseEvent>, nodes: N[]) => void)", "fallback": "", "kind": "option", "name": "onSelectionContextMenu", "refers": ["kit.N", "react.MouseEvent"], "required": false, "says": "This event handler is called when a user right-clicks on a node selection."}, {"accepts": "SelectionDragHandler<N>", "fallback": "", "kind": "option", "name": "onSelectionDrag", "refers": ["kit.N", "react.MouseEvent", "react.SelectionDragHandler"], "required": false, "says": "This event handler gets called when a user drags a selection box."}, {"accepts": "SelectionDragHandler<N>", "fallback": "", "kind": "option", "name": "onSelectionDragStart", "refers": ["kit.N", "react.MouseEvent", "react.SelectionDragHandler"], "required": false, "says": "This event handler gets called when a user starts to drag a selection box."}, {"accepts": "SelectionDragHandler<N>", "fallback": "", "kind": "option", "name": "onSelectionDragStop", "refers": ["kit.N", "react.MouseEvent", "react.SelectionDragHandler"], "required": false, "says": "This event handler gets called when a user stops dragging a selection box."}, {"accepts": "((event: MouseEvent<Element, MouseEvent>) => void)", "fallback": "", "kind": "option", "name": "onSelectionEnd", "refers": ["react.MouseEvent"], "required": false, "says": ""}, {"accepts": "((event: MouseEvent<Element, MouseEvent>) => void)", "fallback": "", "kind": "option", "name": "onSelectionStart", "refers": ["react.MouseEvent"], "required": false, "says": ""}, {"accepts": "((viewport: Viewport) => void)", "fallback": "", "kind": "option", "name": "onViewportChange", "refers": ["system.Viewport"], "required": false, "says": "Used when working with a controlled viewport for updating the user viewport state."}, {"accepts": "KeyCode | null", "fallback": "'Space'", "kind": "option", "name": "panActivationKeyCode", "refers": ["system.KeyCode"], "required": false, "says": "If a key is set, you can pan the viewport while that key is held down even if `panOnScroll` is set to `false`."}, {"accepts": "number", "fallback": "0", "kind": "option", "name": "paneClickDistance", "refers": [], "required": false, "says": "Distance that the mouse can move between mousedown/up that will trigger a click."}, {"accepts": "boolean | number[]", "fallback": "true", "kind": "option", "name": "panOnDrag", "refers": [], "required": false, "says": "Enabling 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. Mouse button arrays do not disable touch panning; set this prop to `false` to disable all drag panning."}, {"accepts": "boolean", "fallback": "false", "kind": "option", "name": "panOnScroll", "refers": [], "required": false, "says": "Controls if the viewport should pan by scrolling inside the container. Can be limited to a specific direction with `panOnScrollMode`."}, {"accepts": "PanOnScrollMode", "fallback": "\"free\"", "kind": "option", "name": "panOnScrollMode", "refers": ["system.Free", "system.Horizontal", "system.PanOnScrollMode", "system.Vertical"], "required": false, "says": "This prop is used to limit the direction of panning when `panOnScroll` is enabled. The `\"free\"` option allows panning in any direction."}, {"accepts": "number", "fallback": "0.5", "kind": "option", "name": "panOnScrollSpeed", "refers": [], "required": false, "says": "Controls how fast viewport should be panned on scroll. Use together with `panOnScroll` prop."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "preventScrolling", "refers": [], "required": false, "says": "Disabling this prop will allow the user to scroll the page even when their pointer is over the flow."}, {"accepts": "ProOptions", "fallback": "", "kind": "option", "name": "proOptions", "refers": ["react.ProOptions"], "required": false, "says": "By default, we render a small attribution in the corner of your flows that links back to the project."}, {"accepts": "boolean", "fallback": "", "kind": "option", "name": "readOnly", "refers": [], "required": false, "says": "Whether the canvas is read and not edited."}, {"accepts": "number", "fallback": "10", "kind": "option", "name": "reconnectRadius", "refers": [], "required": false, "says": "The radius around an edge connection that can trigger an edge reconnection."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "removedLabel", "refers": [], "required": false, "says": "Word of a removed node or edge. `Removed` unless stated."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "removeGlyph", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Glyph of every edge's remove control, from the caller. No remove control renders without one."}, {"accepts": "((ends: EdgeEnds) => string)", "fallback": "", "kind": "option", "name": "removeName", "refers": ["kit.EdgeEnds"], "required": false, "says": "Writes the name of an edge's remove control from the names of its ends, for an edge whose data states no `removeLabel`. `Remove the connection from Orders to Clean orders` unless stated."}, {"accepts": "KeyCode | null", "fallback": "'Shift'", "kind": "option", "name": "selectionKeyCode", "refers": ["system.KeyCode"], "required": false, "says": "If set, holding this key will let you click and drag to draw a selection box around multiple nodes and edges. Passing an array represents multiple keys that can be pressed."}, {"accepts": "SelectionMode", "fallback": "'full'", "kind": "option", "name": "selectionMode", "refers": ["system.Full", "system.Partial", "system.SelectionMode"], "required": false, "says": "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."}, {"accepts": "boolean", "fallback": "false", "kind": "option", "name": "selectionOnDrag", "refers": [], "required": false, "says": "Select multiple elements with a selection box, without pressing down `selectionKey`."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "selectNodesOnDrag", "refers": [], "required": false, "says": "If `true`, nodes get selected on drag."}, {"accepts": "SnapGrid", "fallback": "", "kind": "option", "name": "snapGrid", "refers": ["system.SnapGrid"], "required": false, "says": "If `snapToGrid` is enabled, this prop configures the grid that nodes will snap to."}, {"accepts": "boolean", "fallback": "", "kind": "option", "name": "snapToGrid", "refers": [], "required": false, "says": "When enabled, nodes will snap to the grid when dragged."}, {"accepts": "CoordinateExtent", "fallback": "[[-∞, -∞], [+∞, +∞]]", "kind": "option", "name": "translateExtent", "refers": ["system.CoordinateExtent"], "required": false, "says": "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."}, {"accepts": "Viewport", "fallback": "", "kind": "option", "name": "viewport", "refers": ["system.Viewport"], "required": false, "says": "When you pass a `viewport` prop, it's controlled, and you also need to pass `onViewportChange` to handle internal changes."}, {"accepts": "number", "fallback": "", "kind": "option", "name": "width", "refers": [], "required": false, "says": "Sets a fixed width for the flow."}, {"accepts": "ZIndexMode", "fallback": "'basic'", "kind": "option", "name": "zIndexMode", "refers": ["system.ZIndexMode"], "required": false, "says": "Used to define how z-indexing is calculated for nodes and edges. 'auto' is for selections and sub flows, 'basic' for selections only, and 'manual' for no auto z-indexing."}, {"accepts": "KeyCode | null", "fallback": "\"Meta\" for macOS, \"Control\" for other systems", "kind": "option", "name": "zoomActivationKeyCode", "refers": ["system.KeyCode"], "required": false, "says": "If a key is set, you can zoom the viewport while that key is held down even if `panOnScroll` is set to `false`."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "zoomOnDoubleClick", "refers": [], "required": false, "says": "Controls if the viewport should zoom by double-clicking somewhere on the flow."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "zoomOnPinch", "refers": [], "required": false, "says": "Controls if the viewport should zoom by pinching on a touch screen."}, {"accepts": "boolean", "fallback": "true", "kind": "option", "name": "zoomOnScroll", "refers": [], "required": false, "says": "Controls if the viewport should zoom by scrolling inside the container."}], "CaptionProps": [], "ControlProps": [{"accepts": "ControlAction", "fallback": "", "kind": "option", "name": "action", "refers": ["kit.ControlAction"], "required": true, "says": "Action the control takes on the view: zoom in, zoom out, or fit the graph in view."}, {"accepts": "boolean", "fallback": "", "kind": "option", "name": "disabled", "refers": [], "required": false, "says": "Whether the arrows step past the item."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "id", "refers": [], "required": false, "says": "Identifier the group registers the item under. The item generates one when the caller omits it, and writes the DOM attribute only when the caller passes it."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "label", "refers": [], "required": true, "says": "Accessible name of the control, such as `Zoom in`."}, {"accepts": "Ref<HTMLElement>", "fallback": "", "kind": "option", "name": "ref", "refers": ["react.RefObject", "react.bivarianceHack"], "required": false, "says": "Ref that receives the item's element."}], "ControlsProps": [{"accepts": "string", "fallback": "", "kind": "option", "name": "activeId", "refers": [], "required": false, "says": "Item with the tab stop when the caller controls the group."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "children", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Items of the group."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "defaultActiveId", "refers": [], "required": false, "says": "Item that Tab enters first when the group controls itself."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "label", "refers": [], "required": false, "says": "Accessible name of the toolbar. `Canvas` unless stated."}, {"accepts": "((activeId: string) => void)", "fallback": "", "kind": "option", "name": "onActiveIdChange", "refers": [], "required": false, "says": "Called after the tab stop moves to another item."}, {"accepts": "Orientation", "fallback": "", "kind": "option", "name": "orientation", "refers": ["kit.Orientation"], "required": false, "says": "Axes whose arrows move focus. Defaults to `horizontal`."}, {"accepts": "boolean", "fallback": "", "kind": "option", "name": "wrap", "refers": [], "required": false, "says": "Whether a step past one end continues at the other."}], "EmptyProps": [], "MiniMapProps": [{"accepts": "string", "fallback": "", "kind": "option", "name": "bgColor", "refers": [], "required": false, "says": "Background color of minimap."}, {"accepts": "boolean", "fallback": "", "kind": "option", "name": "inversePan", "refers": [], "required": false, "says": "Invert direction when panning the minimap viewport."}, {"accepts": "string", "fallback": "", "kind": "option", "name": "label", "refers": [], "required": false, "says": "Accessible name of the map. `Overview` unless stated."}, {"accepts": "string", "fallback": "\"rgba(240, 240, 240, 0.6)\"", "kind": "option", "name": "maskColor", "refers": [], "required": false, "says": "The color of the mask that covers the portion of the minimap not currently visible in the viewport."}, {"accepts": "string", "fallback": "transparent", "kind": "option", "name": "maskStrokeColor", "refers": [], "required": false, "says": "Stroke color of mask representing viewport."}, {"accepts": "number", "fallback": "1", "kind": "option", "name": "maskStrokeWidth", "refers": [], "required": false, "says": "Stroke width of mask representing viewport."}, {"accepts": "number", "fallback": "5", "kind": "option", "name": "nodeBorderRadius", "refers": [], "required": false, "says": "Border radius of nodes on minimap."}, {"accepts": "string | GetMiniMapNodeAttribute<Node>", "fallback": "\"\"", "kind": "option", "name": "nodeClassName", "refers": ["react.GetMiniMapNodeAttribute"], "required": false, "says": "Class name applied to nodes on minimap."}, {"accepts": "string | GetMiniMapNodeAttribute<Node>", "fallback": "\"#e2e2e2\"", "kind": "option", "name": "nodeColor", "refers": ["react.GetMiniMapNodeAttribute"], "required": false, "says": "Color of nodes on minimap."}, {"accepts": "ComponentType<MiniMapNodeProps>", "fallback": "", "kind": "option", "name": "nodeComponent", "refers": ["react.CSSProperties", "react.ComponentClass", "react.ComponentType", "react.FunctionComponent", "react.MiniMapNodeProps"], "required": false, "says": "A custom component to render the nodes in the minimap. This component must render an SVG element!"}, {"accepts": "string | GetMiniMapNodeAttribute<Node>", "fallback": "\"transparent\"", "kind": "option", "name": "nodeStrokeColor", "refers": ["react.GetMiniMapNodeAttribute"], "required": false, "says": "Stroke color of nodes on minimap."}, {"accepts": "number", "fallback": "2", "kind": "option", "name": "nodeStrokeWidth", "refers": [], "required": false, "says": "Stroke width of nodes on minimap."}, {"accepts": "number", "fallback": "5", "kind": "option", "name": "offsetScale", "refers": [], "required": false, "says": "Offset the viewport on the minimap, acts like a padding."}, {"accepts": "((event: MouseEvent<Element, MouseEvent>, position: XYPosition) => void)", "fallback": "", "kind": "option", "name": "onClick", "refers": ["react.MouseEvent", "system.XYPosition"], "required": false, "says": "Callback called when minimap is clicked."}, {"accepts": "((event: MouseEvent<Element, MouseEvent>, node: Node) => void)", "fallback": "", "kind": "option", "name": "onNodeClick", "refers": ["react.MouseEvent"], "required": false, "says": "Callback called when node on minimap is clicked."}, {"accepts": "boolean", "fallback": "false", "kind": "option", "name": "pannable", "refers": [], "required": false, "says": "Determines whether you can pan the viewport by dragging inside the minimap."}, {"accepts": "PanelPosition", "fallback": "PanelPosition.BottomRight", "kind": "option", "name": "position", "refers": ["system.PanelPosition"], "required": false, "says": "Position of minimap on pane."}, {"accepts": "boolean", "fallback": "false", "kind": "option", "name": "zoomable", "refers": [], "required": false, "says": "Determines whether you can zoom the viewport by scrolling inside the minimap."}, {"accepts": "number", "fallback": "10", "kind": "option", "name": "zoomStep", "refers": [], "required": false, "says": "Step size for zooming in/out on minimap."}], "NodeProps": [{"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "actions", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Controls in the header, such as a menu, outside the drag surface."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "branch", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Control on the middle of the card's bottom edge, such as one that opens and closes the node's branch."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "children", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Body of the card, such as a configuration's summary."}, {"accepts": "boolean", "fallback": "", "kind": "option", "name": "dimmed", "refers": [], "required": false, "says": "Whether the card recedes, as a node outside a traced path does."}, {"accepts": "GraphDirection", "fallback": "", "kind": "option", "name": "direction", "refers": ["kit.GraphDirection"], "required": false, "says": "Way this node's edges run, where it differs from the graph's."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "icon", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Glyph before the title, from the caller. Hidden from assistive technology."}, {"accepts": "readonly GraphPort[]", "fallback": "", "kind": "option", "name": "inputs", "refers": ["kit.GraphPort"], "required": false, "says": "Ports edges enter, in order along their side."}, {"accepts": "boolean", "fallback": "", "kind": "option", "name": "invalid", "refers": [], "required": false, "says": "Whether the node is misconfigured, which edges the card in the error ink."}, {"accepts": "readonly GraphPort[]", "fallback": "", "kind": "option", "name": "outputs", "refers": ["kit.GraphPort"], "required": false, "says": "Ports edges leave, in order along their side."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "problem", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Fault of an invalid node in one line, shown under the body."}, {"accepts": "GraphStatus", "fallback": "", "kind": "option", "name": "status", "refers": ["kit.GraphStatus"], "required": false, "says": "Status of the node, a dot in a palette beside a word."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "subtitle", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Line under the title, such as the model or the condition."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "tag", "refers": ["react.ReactElement", "react.ReactPortal"], "required": false, "says": "Word above the card's top edge at its end, such as the node's relation to a traced node."}, {"accepts": "ReactNode", "fallback": "", "kind": "option", "name": "title", "refers": ["react.ReactElement", "react.ReactPortal"], "required": true, "says": "Title of the node."}], "PaletteItemProps": [{"accepts": "\"glow\" | \"pulse\"", "fallback": "", "kind": "variant", "name": "effect", "refers": [], "required": false, "says": "The halo around the button, in the palette's solid at half opacity."}, {"accepts": "Lift", "fallback": "", "kind": "variant", "name": "elevation", "refers": ["kit.Lift"], "required": false, "says": ""}, {"accepts": "string", "fallback": "", "kind": "option", "name": "item", "refers": [], "required": true, "says": "Id of the kind of node the item adds, which a drop and a press report."}, {"accepts": "(item: string, position: XYPosition) => void", "fallback": "", "kind": "option", "name": "onAdd", "refers": ["system.XYPosition"], "required": true, "says": "Called with the item's id and the middle of the view when a person presses the item."}, {"accepts": "\"accent\" | \"error\" | \"info\" | \"neutral\" | \"primary\" | \"secondary\" | \"success\" | \"warning\"", "fallback": "", "kind": "variant", "name": "palette", "refers": [], "required": false, "says": "Palette of every look. The base sets `primary`."}, {"accepts": "\"square\"", "fallback": "", "kind": "variant", "name": "shape", "refers": [], "required": false, "says": ""}, {"accepts": "Scale", "fallback": "", "kind": "variant", "name": "size", "refers": ["kit.Scale"], "required": false, "says": ""}, {"accepts": "\"ghost\" | \"glass\" | \"outline\" | \"plain\" | \"solid\" | \"subtle\" | \"surface\"", "fallback": "", "kind": "variant", "name": "variant", "refers": [], "required": false, "says": ""}], "RootProps": [{"accepts": "GraphDirection", "fallback": "", "kind": "option", "name": "direction", "refers": ["kit.GraphDirection"], "required": false, "says": "Way the graph's edges run, which puts each node's inputs and outputs on the matching sides. Down unless stated."}, {"accepts": "Ratio", "fallback": "", "kind": "variant", "name": "ratio", "refers": ["kit.Ratio"], "required": false, "says": "Aspect ratio of the canvas, one of the theme's ratios, which the empty state takes in the canvas's place."}], "SummaryProps": [], "ZoomLevelProps": [{"accepts": "string", "fallback": "", "kind": "option", "name": "locale", "refers": [], "required": false, "says": "Locale the percentage is written in."}]};
|
|
3
|
+
export const shapes = {"react.ReactElement": [{"accepts": "string | JSXElementConstructor<any>", "name": "type", "says": ""}, {"accepts": "unknown", "name": "props", "says": ""}, {"accepts": "string | null", "name": "key", "says": ""}], "react.ReactPortal": [{"accepts": "ReactNode", "name": "children", "says": ""}, {"accepts": "string | JSXElementConstructor<any>", "name": "type", "says": ""}, {"accepts": "unknown", "name": "props", "says": ""}, {"accepts": "string | null", "name": "key", "says": ""}], "kit.NetworkLink": [{"accepts": "string", "name": "id", "says": "Identity of the link. The ids of its ends, joined by a hyphen, unless stated."}, {"accepts": "string", "name": "source", "says": "Id of the node the link leaves."}, {"accepts": "string", "name": "target", "says": "Id of the node the link enters."}, {"accepts": "number", "name": "strength", "says": "How strongly the link ties its ends, 1 unless stated. A tie of 2 or more pulls the ends twice as close as a tie of 1."}], "kit.NetworkNode": [{"accepts": "ReactNode", "name": "icon", "says": "Glyph in the disc, from the caller. Hidden from assistive technology."}, {"accepts": "string", "name": "id", "says": "Identity the links name the node by."}, {"accepts": "string", "name": "label", "says": "Name under the disc, which is also the node's accessible name."}, {"accepts": "number", "name": "weight", "says": "Importance of the node, which sizes its disc against the heaviest node's. The number of its links unless stated."}], "kit.Ratio": [{"accepts": "", "name": "\"golden\"", "says": ""}, {"accepts": "", "name": "\"landscape\"", "says": ""}, {"accepts": "", "name": "\"portrait\"", "says": ""}, {"accepts": "", "name": "\"square\"", "says": ""}, {"accepts": "", "name": "\"ultrawide\"", "says": ""}, {"accepts": "", "name": "\"video\"", "says": ""}, {"accepts": "", "name": "\"wide\"", "says": ""}], "kit.EdgeEnds": [{"accepts": "string", "name": "source", "says": "Name of the node the edge leaves."}, {"accepts": "string", "name": "target", "says": "Name of the node the edge enters."}], "kit.Move": [{"accepts": "string", "name": "direction", "says": "Way the nodes moved: `up`, `down`, `left` or `right`."}, {"accepts": "number", "name": "x", "says": "Position across the canvas the node was at before the move."}, {"accepts": "number", "name": "y", "says": "Position down the canvas the node was at before the move."}], "kit.Connections": [{"accepts": "number", "name": "count", "says": "Number of nodes within `depth` hops of the focused node."}, {"accepts": "string", "name": "name", "says": "Name of the focused node."}], "react.DefaultEdgeOptions": [{"accepts": "string", "name": "type", "says": "Type of edge defined in `edgeTypes`."}, {"accepts": "boolean", "name": "animated", "says": ""}, {"accepts": "boolean", "name": "hidden", "says": ""}, {"accepts": "boolean", "name": "deletable", "says": ""}, {"accepts": "boolean", "name": "selectable", "says": ""}, {"accepts": "Record<string, unknown>", "name": "data", "says": "Arbitrary data passed to an edge."}, {"accepts": "EdgeMarkerType", "name": "markerStart", "says": "Set the marker on the beginning of an edge."}, {"accepts": "EdgeMarkerType", "name": "markerEnd", "says": "Set the marker on the end of an edge."}, {"accepts": "number", "name": "zIndex", "says": ""}, {"accepts": "string", "name": "ariaLabel", "says": ""}, {"accepts": "number", "name": "interactionWidth", "says": "ReactFlow renders an invisible path around each edge to make them easier to click or tap on. This property sets the width of that invisible path."}, {"accepts": "ReactNode", "name": "label", "says": "The label or custom element to render along the edge. This is commonly a text label or some custom controls."}, {"accepts": "CSSProperties", "name": "labelStyle", "says": "Custom styles to apply to the label."}, {"accepts": "boolean", "name": "labelShowBg", "says": ""}, {"accepts": "CSSProperties", "name": "labelBgStyle", "says": ""}, {"accepts": "[number, number]", "name": "labelBgPadding", "says": ""}, {"accepts": "number", "name": "labelBgBorderRadius", "says": ""}, {"accepts": "CSSProperties", "name": "style", "says": ""}, {"accepts": "string", "name": "className", "says": ""}, {"accepts": "boolean | HandleType", "name": "reconnectable", "says": "Determines whether the edge can be updated by dragging the source or target to a new node. This property will override the default set by the `edgesReconnectable` prop on the `<ReactFlow />` component."}, {"accepts": "boolean", "name": "focusable", "says": ""}, {"accepts": "AriaRole", "name": "ariaRole", "says": "The ARIA role attribute for the edge, used for accessibility."}, {"accepts": "Omit<SVGAttributes<SVGGElement>, \"aria-label\" | \"className\" | \"dangerouslySetInnerHTML\" | \"id\" | \"role\" | \"style\">", "name": "domAttributes", "says": "General escape hatch for adding custom attributes to the edge's DOM element."}], "system.EdgeMarkerType": [{"accepts": "", "name": "string", "says": ""}, {"accepts": "", "name": "EdgeMarker", "says": ""}], "system.EdgeMarker": [{"accepts": "\"arrow\" | \"arrowclosed\" | MarkerType", "name": "type", "says": ""}, {"accepts": "string | null", "name": "color", "says": ""}, {"accepts": "number", "name": "width", "says": ""}, {"accepts": "number", "name": "height", "says": ""}, {"accepts": "string", "name": "markerUnits", "says": ""}, {"accepts": "string", "name": "orient", "says": ""}, {"accepts": "number", "name": "strokeWidth", "says": ""}], "react.AriaRole": [{"accepts": "", "name": "\"alert\"", "says": ""}, {"accepts": "", "name": "\"alertdialog\"", "says": ""}, {"accepts": "", "name": "\"application\"", "says": ""}, {"accepts": "", "name": "\"article\"", "says": ""}, {"accepts": "", "name": "\"banner\"", "says": ""}, {"accepts": "", "name": "\"button\"", "says": ""}, {"accepts": "", "name": "\"cell\"", "says": ""}, {"accepts": "", "name": "\"checkbox\"", "says": ""}, {"accepts": "", "name": "\"columnheader\"", "says": ""}, {"accepts": "", "name": "\"combobox\"", "says": ""}, {"accepts": "", "name": "\"complementary\"", "says": ""}, {"accepts": "", "name": "\"contentinfo\"", "says": ""}, {"accepts": "", "name": "\"definition\"", "says": ""}, {"accepts": "", "name": "\"dialog\"", "says": ""}, {"accepts": "", "name": "\"directory\"", "says": ""}, {"accepts": "", "name": "\"document\"", "says": ""}, {"accepts": "", "name": "\"feed\"", "says": ""}, {"accepts": "", "name": "\"figure\"", "says": ""}, {"accepts": "", "name": "\"form\"", "says": ""}, {"accepts": "", "name": "\"grid\"", "says": ""}, {"accepts": "", "name": "\"gridcell\"", "says": ""}, {"accepts": "", "name": "\"group\"", "says": ""}, {"accepts": "", "name": "\"heading\"", "says": ""}, {"accepts": "", "name": "\"img\"", "says": ""}, {"accepts": "", "name": "\"link\"", "says": ""}, {"accepts": "", "name": "\"list\"", "says": ""}, {"accepts": "", "name": "\"listbox\"", "says": ""}, {"accepts": "", "name": "\"listitem\"", "says": ""}, {"accepts": "", "name": "\"log\"", "says": ""}, {"accepts": "", "name": "\"main\"", "says": ""}, {"accepts": "", "name": "\"marquee\"", "says": ""}, {"accepts": "", "name": "\"math\"", "says": ""}, {"accepts": "", "name": "\"menu\"", "says": ""}, {"accepts": "", "name": "\"menubar\"", "says": ""}, {"accepts": "", "name": "\"menuitem\"", "says": ""}, {"accepts": "", "name": "\"menuitemcheckbox\"", "says": ""}, {"accepts": "", "name": "\"menuitemradio\"", "says": ""}, {"accepts": "", "name": "\"navigation\"", "says": ""}, {"accepts": "", "name": "\"none\"", "says": ""}, {"accepts": "", "name": "\"note\"", "says": ""}, {"accepts": "", "name": "\"option\"", "says": ""}, {"accepts": "", "name": "\"presentation\"", "says": ""}, {"accepts": "", "name": "\"progressbar\"", "says": ""}, {"accepts": "", "name": "\"radio\"", "says": ""}, {"accepts": "", "name": "\"radiogroup\"", "says": ""}, {"accepts": "", "name": "\"region\"", "says": ""}, {"accepts": "", "name": "\"row\"", "says": ""}, {"accepts": "", "name": "\"rowgroup\"", "says": ""}, {"accepts": "", "name": "\"rowheader\"", "says": ""}, {"accepts": "", "name": "\"scrollbar\"", "says": ""}, {"accepts": "", "name": "\"search\"", "says": ""}, {"accepts": "", "name": "\"searchbox\"", "says": ""}, {"accepts": "", "name": "\"separator\"", "says": ""}, {"accepts": "", "name": "\"slider\"", "says": ""}, {"accepts": "", "name": "\"spinbutton\"", "says": ""}, {"accepts": "", "name": "\"status\"", "says": ""}, {"accepts": "", "name": "\"switch\"", "says": ""}, {"accepts": "", "name": "\"tab\"", "says": ""}, {"accepts": "", "name": "\"table\"", "says": ""}, {"accepts": "", "name": "\"tablist\"", "says": ""}, {"accepts": "", "name": "\"tabpanel\"", "says": ""}, {"accepts": "", "name": "\"term\"", "says": ""}, {"accepts": "", "name": "\"textbox\"", "says": ""}, {"accepts": "", "name": "\"timer\"", "says": ""}, {"accepts": "", "name": "\"toolbar\"", "says": ""}, {"accepts": "", "name": "\"tooltip\"", "says": ""}, {"accepts": "", "name": "\"tree\"", "says": ""}, {"accepts": "", "name": "\"treegrid\"", "says": ""}, {"accepts": "", "name": "\"treeitem\"", "says": ""}, {"accepts": "", "name": "string & {}", "says": ""}], "system.Connection": [{"accepts": "string", "name": "source", "says": "The id of the node this connection originates from."}, {"accepts": "string", "name": "target", "says": "The id of the node this connection terminates at."}, {"accepts": "string | null", "name": "sourceHandle", "says": "When not `null`, the id of the handle on the source node that this connection originates from."}, {"accepts": "string | null", "name": "targetHandle", "says": "When not `null`, the id of the handle on the target node that this connection terminates at."}], "system.HandleType": [{"accepts": "", "name": "\"source\"", "says": ""}, {"accepts": "", "name": "\"target\"", "says": ""}], "system.FinalConnectionState": [{"accepts": "", "name": "Omit<NoConnection, \"inProgress\">", "says": ""}, {"accepts": "", "name": "Omit<ConnectionInProgress<InternalNodeBase>, \"inProgress\" | \"toPosition\"> & { toPosition: Position | null; }", "says": ""}], "system.NoConnection": [{"accepts": "false", "name": "inProgress", "says": ""}, {"accepts": "null", "name": "isValid", "says": ""}, {"accepts": "null", "name": "from", "says": ""}, {"accepts": "null", "name": "fromHandle", "says": ""}, {"accepts": "null", "name": "fromPosition", "says": ""}, {"accepts": "null", "name": "fromNode", "says": ""}, {"accepts": "null", "name": "to", "says": ""}, {"accepts": "null", "name": "toHandle", "says": ""}, {"accepts": "null", "name": "toPosition", "says": ""}, {"accepts": "null", "name": "toNode", "says": ""}, {"accepts": "null", "name": "pointer", "says": ""}], "system.ConnectionInProgress": [{"accepts": "true", "name": "inProgress", "says": "Indicates whether a connection is currently in progress."}, {"accepts": "boolean | null", "name": "isValid", "says": "If an ongoing connection is above a handle or inside the connection radius, this will be `true` or `false`, otherwise `null`."}, {"accepts": "XYPosition", "name": "from", "says": "Returns the xy start position or `null` if no connection is in progress."}, {"accepts": "Handle", "name": "fromHandle", "says": "Returns the start handle or `null` if no connection is in progress."}, {"accepts": "Position", "name": "fromPosition", "says": "Returns the side (called position) of the start handle or `null` if no connection is in progress."}, {"accepts": "InternalNodeBase", "name": "fromNode", "says": "Returns the start node or `null` if no connection is in progress."}, {"accepts": "XYPosition", "name": "to", "says": "Returns the xy end position or `null` if no connection is in progress."}, {"accepts": "Handle | null", "name": "toHandle", "says": "Returns the end handle or `null` if no connection is in progress."}, {"accepts": "Position", "name": "toPosition", "says": "Returns the side (called position) of the end handle or `null` if no connection is in progress."}, {"accepts": "InternalNodeBase | null", "name": "toNode", "says": "Returns the end node or `null` if no connection is in progress."}, {"accepts": "XYPosition", "name": "pointer", "says": "Returns the pointer position or `null` if no connection is in progress."}], "system.NodeChange": [{"accepts": "", "name": "NodeAddChange<N>", "says": ""}, {"accepts": "", "name": "NodeDimensionChange", "says": ""}, {"accepts": "", "name": "NodePositionChange", "says": ""}, {"accepts": "", "name": "NodeRemoveChange", "says": ""}, {"accepts": "", "name": "NodeReplaceChange<N>", "says": ""}, {"accepts": "", "name": "NodeSelectionChange", "says": ""}], "system.NodeAddChange": [{"accepts": "N", "name": "item", "says": ""}, {"accepts": "\"add\"", "name": "type", "says": ""}, {"accepts": "number", "name": "index", "says": ""}], "system.NodeDimensionChange": [{"accepts": "string", "name": "id", "says": ""}, {"accepts": "\"dimensions\"", "name": "type", "says": ""}, {"accepts": "Dimensions", "name": "dimensions", "says": ""}, {"accepts": "boolean", "name": "resizing", "says": ""}, {"accepts": "\"height\" | \"width\" | boolean", "name": "setAttributes", "says": ""}], "system.NodePositionChange": [{"accepts": "string", "name": "id", "says": ""}, {"accepts": "\"position\"", "name": "type", "says": ""}, {"accepts": "XYPosition", "name": "position", "says": ""}, {"accepts": "XYPosition", "name": "positionAbsolute", "says": ""}, {"accepts": "boolean", "name": "dragging", "says": ""}], "system.NodeRemoveChange": [{"accepts": "string", "name": "id", "says": ""}, {"accepts": "\"remove\"", "name": "type", "says": ""}], "system.NodeReplaceChange": [{"accepts": "string", "name": "id", "says": ""}, {"accepts": "N", "name": "item", "says": ""}, {"accepts": "\"replace\"", "name": "type", "says": ""}], "system.NodeSelectionChange": [{"accepts": "string", "name": "id", "says": ""}, {"accepts": "\"select\"", "name": "type", "says": ""}, {"accepts": "boolean", "name": "selected", "says": ""}], "system.EdgeChange": [{"accepts": "", "name": "EdgeAddChange<E>", "says": ""}, {"accepts": "", "name": "EdgeReplaceChange<E>", "says": ""}, {"accepts": "", "name": "NodeRemoveChange", "says": ""}, {"accepts": "", "name": "NodeSelectionChange", "says": ""}], "system.EdgeAddChange": [{"accepts": "E", "name": "item", "says": ""}, {"accepts": "\"add\"", "name": "type", "says": ""}, {"accepts": "number", "name": "index", "says": ""}], "system.EdgeReplaceChange": [{"accepts": "string", "name": "id", "says": ""}, {"accepts": "E", "name": "item", "says": ""}, {"accepts": "\"replace\"", "name": "type", "says": ""}], "system.OnConnectStartParams": [{"accepts": "string | null", "name": "nodeId", "says": ""}, {"accepts": "string | null", "name": "handleId", "says": ""}, {"accepts": "HandleType | null", "name": "handleType", "says": ""}], "react.GeneralHelpers": [{"accepts": "() => N[]", "name": "getNodes", "says": "Returns nodes."}, {"accepts": "(payload: N[] | ((nodes: N[]) => N[])) => void", "name": "setNodes", "says": "Set your nodes array to something else by either overwriting it with a new array or by passing in a function to update the existing array. If using a function, it is important to make sure a new array is returned instead of mutating the existing array. Calling this function will trigger the `onNodesChange` handler in a controlled flow."}, {"accepts": "(payload: N | N[]) => void", "name": "addNodes", "says": "Add one or many nodes to your existing nodes array. Calling this function will trigger the `onNodesChange` handler in a controlled flow."}, {"accepts": "(id: string) => N", "name": "getNode", "says": "Returns a node by id."}, {"accepts": "(id: string) => InternalNode<N>", "name": "getInternalNode", "says": "Returns an internal node by id."}, {"accepts": "() => E[]", "name": "getEdges", "says": "Returns edges."}, {"accepts": "(payload: E[] | ((edges: E[]) => E[])) => void", "name": "setEdges", "says": "Set your edges array to something else by either overwriting it with a new array or by passing in a function to update the existing array. If using a function, it is important to make sure a new array is returned instead of mutating the existing array. Calling this function will trigger the `onEdgesChange` handler in a controlled flow."}, {"accepts": "(payload: E | E[]) => void", "name": "addEdges", "says": "Add one or many edges to your existing edges array. Calling this function will trigger the `onEdgesChange` handler in a controlled flow."}, {"accepts": "(id: string) => E", "name": "getEdge", "says": "Returns an edge by id."}, {"accepts": "() => ReactFlowJsonObject<N, E>", "name": "toObject", "says": "Returns the nodes, edges and the viewport as a JSON object."}, {"accepts": "(params: DeleteElementsOptions) => Promise<{ deletedNodes: Node[]; deletedEdges: Edge[]; }>", "name": "deleteElements", "says": "Deletes nodes and edges."}, {"accepts": "(node: N | { id: string; } | Rect, partially?: boolean, nodes?: N[]) => N[]", "name": "getIntersectingNodes", "says": "Find all the nodes currently intersecting with a given node or rectangle. The `partially` parameter can be set to `true` to include nodes that are only partially intersecting."}, {"accepts": "(node: N | { id: string; } | Rect, area: Rect, partially?: boolean) => boolean", "name": "isNodeIntersecting", "says": "Determine if a given node or rectangle is intersecting with another rectangle. The `partially` parameter can be set to true return `true` even if the node is only partially intersecting."}, {"accepts": "(id: string, nodeUpdate: Partial<N> | ((node: N) => Partial<N>), options?: { replace: boolean; }) => void", "name": "updateNode", "says": "Updates a node."}, {"accepts": "(id: string, dataUpdate: Partial<N[\"data\"]> | ((node: N) => Partial<N[\"data\"]>), options?: { replace: boolean; }) => void", "name": "updateNodeData", "says": "Updates the data attribute of a node."}, {"accepts": "(id: string, edgeUpdate: Partial<E> | ((edge: E) => Partial<E>), options?: { replace: boolean; }) => void", "name": "updateEdge", "says": "Updates an edge."}, {"accepts": "(id: string, dataUpdate: Partial<E[\"data\"]> | ((edge: E) => Partial<E[\"data\"]>), options?: { replace: boolean; }) => void", "name": "updateEdgeData", "says": "Updates the data attribute of a edge."}, {"accepts": "(nodes: (string | N | InternalNode)[]) => Rect", "name": "getNodesBounds", "says": "Returns the bounds of the given nodes or node ids."}, {"accepts": "({ type, id, nodeId, }: { type: HandleType; nodeId: string; id?: string | null; }) => HandleConnection[]", "name": "getHandleConnections", "says": "Get all the connections of a handle belonging to a specific node. The type parameter be either `'source'` or `'target'`."}, {"accepts": "({ type, handleId, nodeId, }: { type?: HandleType; nodeId: string; handleId?: string | null; }) => NodeConnection[]", "name": "getNodeConnections", "says": "Gets all connections to a node. Can be filtered by handle type and id."}, {"accepts": "FitView<N>", "name": "fitView", "says": "Fits the view based on the passed params. By default it fits the view to all nodes."}], "react.ViewportHelperFunctions": [{"accepts": "ZoomInOut", "name": "zoomIn", "says": "Zooms viewport in by 1.2."}, {"accepts": "ZoomInOut", "name": "zoomOut", "says": "Zooms viewport out by 1 / 1.2."}, {"accepts": "ZoomTo", "name": "zoomTo", "says": "Zoom the viewport to a given zoom level. Passing in a `duration` will animate the viewport to the new zoom level."}, {"accepts": "GetZoom", "name": "getZoom", "says": "Get the current zoom level of the viewport."}, {"accepts": "SetViewport", "name": "setViewport", "says": "Sets the current viewport."}, {"accepts": "GetViewport", "name": "getViewport", "says": "Returns the current viewport."}, {"accepts": "SetCenter", "name": "setCenter", "says": "Center the viewport on a given position. Passing in a `duration` will animate the viewport to the new position."}, {"accepts": "FitBounds", "name": "fitBounds", "says": "A low-level utility function to fit the viewport to a given rectangle. By passing in a `duration`, the viewport will animate from its current position to the new position. The `padding` option can be used to add space around the bounds."}, {"accepts": "(clientPosition: XYPosition, options?: { snapToGrid?: boolean; snapGrid?: SnapGrid; }) => XYPosition", "name": "screenToFlowPosition", "says": "With this function you can translate a screen pixel position to a flow position. It is useful for implementing drag and drop from a sidebar for example."}, {"accepts": "(flowPosition: XYPosition) => XYPosition", "name": "flowToScreenPosition", "says": "Translate a position inside the flow's canvas to a screen pixel position."}], "system.Viewport": [{"accepts": "number", "name": "x", "says": ""}, {"accepts": "number", "name": "y", "says": ""}, {"accepts": "number", "name": "zoom", "says": ""}], "react.OnSelectionChangeParams": [{"accepts": "N[]", "name": "nodes", "says": ""}, {"accepts": "E[]", "name": "edges", "says": ""}], "system.ConnectionLineType": [{"accepts": "", "name": "ConnectionLineType.Bezier", "says": ""}, {"accepts": "", "name": "ConnectionLineType.Straight", "says": ""}, {"accepts": "", "name": "ConnectionLineType.Step", "says": ""}, {"accepts": "", "name": "ConnectionLineType.SmoothStep", "says": ""}, {"accepts": "", "name": "ConnectionLineType.SimpleBezier", "says": ""}], "react.ConnectionLineComponent": [{"accepts": "", "name": "ComponentClass<ConnectionLineComponentProps<N>, any>", "says": ""}, {"accepts": "", "name": "FunctionComponent<ConnectionLineComponentProps<N>>", "says": ""}], "react.ConnectionLineComponentProps": [{"accepts": "CSSProperties", "name": "connectionLineStyle", "says": ""}, {"accepts": "ConnectionLineType", "name": "connectionLineType", "says": ""}, {"accepts": "InternalNode<N>", "name": "fromNode", "says": "The node the connection line originates from."}, {"accepts": "Handle", "name": "fromHandle", "says": "The handle on the `fromNode` that the connection line originates from."}, {"accepts": "number", "name": "fromX", "says": ""}, {"accepts": "number", "name": "fromY", "says": ""}, {"accepts": "number", "name": "toX", "says": ""}, {"accepts": "number", "name": "toY", "says": ""}, {"accepts": "Position", "name": "fromPosition", "says": ""}, {"accepts": "Position", "name": "toPosition", "says": ""}, {"accepts": "\"invalid\" | \"valid\" | null", "name": "connectionStatus", "says": "If there is an `isValidConnection` callback, this prop will be set to `\"valid\"` or `\"invalid\"` based on the return value of that callback. Otherwise, it will be `null`."}, {"accepts": "InternalNode<N> | null", "name": "toNode", "says": ""}, {"accepts": "Handle | null", "name": "toHandle", "says": ""}, {"accepts": "XYPosition", "name": "pointer", "says": ""}], "system.Handle": [{"accepts": "string | null", "name": "id", "says": ""}, {"accepts": "string", "name": "nodeId", "says": ""}, {"accepts": "number", "name": "x", "says": ""}, {"accepts": "number", "name": "y", "says": ""}, {"accepts": "Position", "name": "position", "says": ""}, {"accepts": "HandleType", "name": "type", "says": ""}, {"accepts": "number", "name": "width", "says": ""}, {"accepts": "number", "name": "height", "says": ""}], "system.Position": [{"accepts": "", "name": "Position.Left", "says": ""}, {"accepts": "", "name": "Position.Top", "says": ""}, {"accepts": "", "name": "Position.Right", "says": ""}, {"accepts": "", "name": "Position.Bottom", "says": ""}], "system.XYPosition": [{"accepts": "number", "name": "x", "says": ""}, {"accepts": "number", "name": "y", "says": ""}], "react.ComponentClass": [{"accepts": "any", "name": "propTypes", "says": "Ignored by React."}, {"accepts": "Context<any>", "name": "contextType", "says": ""}, {"accepts": "Partial<ConnectionLineComponentProps<N>>", "name": "defaultProps", "says": ""}, {"accepts": "string", "name": "displayName", "says": "Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes."}, {"accepts": "GetDerivedStateFromProps<ConnectionLineComponentProps<N>, any>", "name": "getDerivedStateFromProps", "says": ""}, {"accepts": "GetDerivedStateFromError<ConnectionLineComponentProps<N>, any>", "name": "getDerivedStateFromError", "says": ""}], "react.ProviderProps": [{"accepts": "any", "name": "value", "says": ""}, {"accepts": "ReactNode", "name": "children", "says": ""}], "react.Context": [{"accepts": "Provider<any>", "name": "Provider", "says": ""}, {"accepts": "Consumer<any>", "name": "Consumer", "says": ""}, {"accepts": "string", "name": "displayName", "says": "Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes."}, {"accepts": "symbol", "name": "$$typeof", "says": ""}], "react.Provider": [{"accepts": "symbol", "name": "$$typeof", "says": ""}], "react.Consumer": [{"accepts": "symbol", "name": "$$typeof", "says": ""}], "react.FunctionComponent": [{"accepts": "any", "name": "propTypes", "says": "Ignored by React."}, {"accepts": "string", "name": "displayName", "says": "Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes."}], "system.ConnectionMode": [{"accepts": "", "name": "ConnectionMode.Strict", "says": ""}, {"accepts": "", "name": "ConnectionMode.Loose", "says": ""}], "system.KeyCode": [{"accepts": "", "name": "string", "says": ""}, {"accepts": "", "name": "string[]", "says": ""}], "system.SelectionMode": [{"accepts": "", "name": "SelectionMode.Partial", "says": ""}, {"accepts": "", "name": "SelectionMode.Full", "says": ""}], "system.PanOnScrollMode": [{"accepts": "", "name": "PanOnScrollMode.Free", "says": ""}, {"accepts": "", "name": "PanOnScrollMode.Vertical", "says": ""}, {"accepts": "", "name": "PanOnScrollMode.Horizontal", "says": ""}], "react.FitViewOptions": [{"accepts": "Padding", "name": "padding", "says": ""}, {"accepts": "boolean", "name": "includeHiddenNodes", "says": ""}, {"accepts": "number", "name": "minZoom", "says": ""}, {"accepts": "number", "name": "maxZoom", "says": ""}, {"accepts": "number", "name": "duration", "says": ""}, {"accepts": "((t: number) => number)", "name": "ease", "says": ""}, {"accepts": "\"linear\" | \"smooth\"", "name": "interpolate", "says": ""}, {"accepts": "({ id: string; } | Node)[]", "name": "nodes", "says": ""}], "system.Padding": [{"accepts": "", "name": "number", "says": ""}, {"accepts": "", "name": "{ top?: PaddingWithUnit; right?: PaddingWithUnit; bottom?: PaddingWithUnit; left?: PaddingWithUnit; x?: PaddingWithUnit; y?: PaddingWithUnit; }", "says": ""}, {"accepts": "", "name": "`${number}%`", "says": ""}, {"accepts": "", "name": "`${number}px`", "says": ""}], "system.PanelPosition": [{"accepts": "", "name": "\"bottom-center\"", "says": ""}, {"accepts": "", "name": "\"bottom-left\"", "says": ""}, {"accepts": "", "name": "\"bottom-right\"", "says": ""}, {"accepts": "", "name": "\"center-left\"", "says": ""}, {"accepts": "", "name": "\"center-right\"", "says": ""}, {"accepts": "", "name": "\"top-center\"", "says": ""}, {"accepts": "", "name": "\"top-left\"", "says": ""}, {"accepts": "", "name": "\"top-right\"", "says": ""}], "react.ProOptions": [{"accepts": "string", "name": "account", "says": ""}, {"accepts": "boolean", "name": "hideAttribution", "says": "If you hide the attribution, please support our work with a subscription."}], "system.ZIndexMode": [{"accepts": "", "name": "\"auto\"", "says": ""}, {"accepts": "", "name": "\"basic\"", "says": ""}, {"accepts": "", "name": "\"manual\"", "says": ""}], "kit.GraphDiff": [{"accepts": "readonly GraphChange[]", "name": "edges", "says": "Every edge of either version."}, {"accepts": "readonly GraphChange[]", "name": "nodes", "says": "Every node of either version."}], "kit.GraphChange": [{"accepts": "GraphChangeType", "name": "change", "says": "Kind of change the node or the edge went through."}, {"accepts": "readonly string[]", "name": "fields", "says": "Fields of a changed node's data that differ, sorted. Empty for anything else."}, {"accepts": "string", "name": "id", "says": "Id of the node or the edge in the version it is in, the later one where it is in both."}, {"accepts": "string", "name": "label", "says": "Name of the node, or the edge's name from the names of its ends."}], "kit.GraphEdit": [{"accepts": "E[]", "name": "edges", "says": "Edges of the graph after the edit."}, {"accepts": "N[]", "name": "nodes", "says": "Nodes of the graph after the edit."}], "kit.GraphStep": [{"accepts": "readonly string[]", "name": "edges", "says": "Ids of the edges the edit connected or removed."}, {"accepts": "readonly string[]", "name": "nodes", "says": "Ids of the nodes the edit moved or removed."}, {"accepts": "GraphStepType", "name": "type", "says": "Kind of the edit."}], "kit.GraphStepType": [{"accepts": "", "name": "\"connect\"", "says": ""}, {"accepts": "", "name": "\"move\"", "says": ""}, {"accepts": "", "name": "\"remove\"", "says": ""}], "kit.ControlAction": [{"accepts": "", "name": "\"fit\"", "says": ""}, {"accepts": "", "name": "\"zoomIn\"", "says": ""}, {"accepts": "", "name": "\"zoomOut\"", "says": ""}], "react.RefObject": [{"accepts": "HTMLElement | null", "name": "current", "says": "The current value of the ref."}], "kit.Orientation": [{"accepts": "", "name": "\"both\"", "says": ""}, {"accepts": "", "name": "\"horizontal\"", "says": ""}, {"accepts": "", "name": "\"vertical\"", "says": ""}], "react.ComponentType": [{"accepts": "", "name": "ComponentClass<MiniMapNodeProps, any>", "says": ""}, {"accepts": "", "name": "FunctionComponent<MiniMapNodeProps>", "says": ""}], "react.MiniMapNodeProps": [{"accepts": "string", "name": "id", "says": ""}, {"accepts": "number", "name": "x", "says": ""}, {"accepts": "number", "name": "y", "says": ""}, {"accepts": "number", "name": "width", "says": ""}, {"accepts": "number", "name": "height", "says": ""}, {"accepts": "number", "name": "borderRadius", "says": ""}, {"accepts": "string", "name": "className", "says": ""}, {"accepts": "string", "name": "color", "says": ""}, {"accepts": "string", "name": "shapeRendering", "says": ""}, {"accepts": "string", "name": "strokeColor", "says": ""}, {"accepts": "number", "name": "strokeWidth", "says": ""}, {"accepts": "CSSProperties", "name": "style", "says": ""}, {"accepts": "boolean", "name": "selected", "says": ""}, {"accepts": "((event: MouseEvent<Element, MouseEvent>, id: string) => void)", "name": "onClick", "says": ""}], "kit.GraphDirection": [{"accepts": "", "name": "\"down\"", "says": ""}, {"accepts": "", "name": "\"right\"", "says": ""}], "kit.GraphPort": [{"accepts": "boolean", "name": "disabled", "says": "Whether the port refuses new connections. It still renders."}, {"accepts": "string", "name": "id", "says": "Identity an edge's `sourceHandle` or `targetHandle` names the port by."}, {"accepts": "string", "name": "label", "says": "Name of the port, such as `Pass` beside `Fail`."}, {"accepts": "boolean", "name": "unused", "says": "Whether no edge meets the port. An unused port is still rendered and measured, and is invisible, so an edge that meets it later finds it."}], "kit.GraphStatus": [{"accepts": "string", "name": "label", "says": "Word of the status, such as `Running`."}, {"accepts": "\"accent\" | \"error\" | \"info\" | \"neutral\" | \"primary\" | \"secondary\" | \"success\" | \"warning\"", "name": "palette", "says": "Palette of the status's dot."}], "kit.Lift": [{"accepts": "", "name": "\"floating\"", "says": ""}, {"accepts": "", "name": "\"raised\"", "says": ""}], "kit.Scale": [{"accepts": "", "name": "\"2xl\"", "says": ""}, {"accepts": "", "name": "\"3xl\"", "says": ""}, {"accepts": "", "name": "\"4xl\"", "says": ""}, {"accepts": "", "name": "\"lg\"", "says": ""}, {"accepts": "", "name": "\"md\"", "says": ""}, {"accepts": "", "name": "\"sm\"", "says": ""}, {"accepts": "", "name": "\"xl\"", "says": ""}, {"accepts": "", "name": "\"xs\"", "says": ""}]};
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
{
|
|
2
|
+
"format": 1,
|
|
3
|
+
"pages": [
|
|
4
|
+
{
|
|
5
|
+
"about": "directed-graph.about",
|
|
6
|
+
"group": "",
|
|
7
|
+
"id": "components/graphs/directed-graph",
|
|
8
|
+
"module": "directed-graph/directed-graph.js",
|
|
9
|
+
"namespace": "",
|
|
10
|
+
"props": "directed-graph/directed-graph.props.js",
|
|
11
|
+
"specimen": "src/directed-graph/directed-graph.specimen.tsx",
|
|
12
|
+
"title": "directed-graph.title"
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
"about": "graph.about",
|
|
16
|
+
"group": "",
|
|
17
|
+
"id": "components/graphs/graph",
|
|
18
|
+
"module": "graph/graph.js",
|
|
19
|
+
"namespace": "",
|
|
20
|
+
"props": "graph/graph.props.js",
|
|
21
|
+
"specimen": "src/graph/graph.specimen.tsx",
|
|
22
|
+
"title": "graph.title"
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"about": "network-graph.about",
|
|
26
|
+
"group": "",
|
|
27
|
+
"id": "components/graphs/network-graph",
|
|
28
|
+
"module": "network-graph/network-graph.js",
|
|
29
|
+
"namespace": "",
|
|
30
|
+
"props": "network-graph/network-graph.props.js",
|
|
31
|
+
"specimen": "src/network-graph/network-graph.specimen.tsx",
|
|
32
|
+
"title": "network-graph.title"
|
|
33
|
+
}
|
|
34
|
+
],
|
|
35
|
+
"requires": {
|
|
36
|
+
"@stealthscale/component-collections": "^0.1.0",
|
|
37
|
+
"@stealthscale/component-forms": "^0.3.0",
|
|
38
|
+
"@stealthscale/component-layout": "^0.2.0",
|
|
39
|
+
"@stealthscale/component-typography": "^0.3.0",
|
|
40
|
+
"@stealthscale/specimen": "^0.3.0",
|
|
41
|
+
"lucide-react": "^1.52.0"
|
|
42
|
+
}
|
|
43
|
+
}
|