@hlang-org/editor-ui

Classes

LiveSignalStore

Defined in: packages/editor-ui/src/live/live-signal-store.ts:58

Constructors

Constructor

new LiveSignalStore(deps?): LiveSignalStore;

Defined in: packages/editor-ui/src/live/live-signal-store.ts:77

Parameters

Returns

LiveSignalStore

Methods

getNodeState()

getNodeState(nodeId): NodeLiveState;

Defined in: packages/editor-ui/src/live/live-signal-store.ts:135

Current live state of a node.

Parameters

Returns

NodeLiveState

isEdgeFlowing()

isEdgeFlowing(edgeId): boolean;

Defined in: packages/editor-ui/src/live/live-signal-store.ts:147

Whether an edge is currently flowing.

Parameters

Returns

boolean

markActivity()

markActivity(nodeId, portId): void;

Defined in: packages/editor-ui/src/live/live-signal-store.ts:97

Record a node emitting on an output port (drives node + edge activity).

Parameters

Returns

void

markError()

markError(nodeId): void;

Defined in: packages/editor-ui/src/live/live-signal-store.ts:110

Record a node erroring (sticky for the run).

Parameters

Returns

void

reset()

reset(): void;

Defined in: packages/editor-ui/src/live/live-signal-store.ts:116

Clear all live state (on stop/teardown) and notify everyone.

Returns

void

setEdgeIndex()

setEdgeIndex(edges): void;

Defined in: packages/editor-ui/src/live/live-signal-store.ts:82

Provide the current edge index (call whenever edges change).

Parameters

Returns

void

subscribeEdge()

subscribeEdge(edgeId, listener): () => void;

Defined in: packages/editor-ui/src/live/live-signal-store.ts:130

Subscribe to a single edge's flowing state.

Parameters

Returns

() => void

subscribeNode()

subscribeNode(nodeId, listener): () => void;

Defined in: packages/editor-ui/src/live/live-signal-store.ts:125

Subscribe to a single node's live state.

Parameters

Returns

() => void

Interfaces

AssetGridProps

Defined in: packages/editor-ui/src/panels/AssetGrid.tsx:17

Properties

AssetItem

Defined in: packages/editor-ui/src/panels/AssetGrid.tsx:11

Properties

AssetNodeChromeProps

Defined in: packages/editor-ui/src/nodes/AssetNode.tsx:20

Properties

CanvasChromeProps

Defined in: packages/editor-ui/src/canvas/CanvasChrome.tsx:13

Properties

CanvasDockProps

Defined in: packages/editor-ui/src/canvas/CanvasDock.tsx:18

Properties

CheatsheetProps

Defined in: packages/editor-ui/src/overlays/Cheatsheet.tsx:21

Properties

ConnectableResult

Defined in: packages/editor-ui/src/command-palette/node-search-model.ts:62

A search result augmented with the specific port on the candidate node that would complete a pending connection.

Properties

ContextMenuItem

Defined in: packages/editor-ui/src/context-menu/NodeContextMenu.tsx:22

One menu row. A separator is a bare { separator: true }.

Properties

DiagnosticBadgeProps

Defined in: packages/editor-ui/src/panels/DiagnosticBadge.tsx:12

Properties

EdgeIndexEntry

Defined in: packages/editor-ui/src/live/live-signal-store.ts:29

Minimal edge shape the store needs to map a source-port pulse to edges.

Properties

EditorHotkeysOptions

Defined in: packages/editor-ui/src/hooks/useEditorHotkeys.ts:32

Properties

EditorShellProps

Defined in: packages/editor-ui/src/shell/EditorShell.tsx:11

Properties

EditorUIThemeProviderProps

Defined in: packages/editor-ui/src/tokens/ThemeProvider.tsx:12

Properties

EmptyStateProps

Defined in: packages/editor-ui/src/canvas/EmptyState.tsx:10

Properties

FuzzyCandidate

Defined in: packages/editor-ui/src/command-palette/fuzzy.ts:77

A candidate to rank, carrying an opaque payload of type T.

Type Parameters

Properties

FuzzyMatch

Defined in: packages/editor-ui/src/command-palette/fuzzy.ts:10

A scored match with the matched character positions (for highlighting).

Properties

FuzzyResult

Defined in: packages/editor-ui/src/command-palette/fuzzy.ts:83

A ranked result: the candidate plus its match.

Type Parameters

Properties

HlangFlowTypes

Defined in: packages/editor-ui/src/nodes/flow-types.ts:16

Properties

InspectorPanelProps

Defined in: packages/editor-ui/src/panels/InspectorPanel.tsx:18

Properties

LiveSignalProviderProps

Defined in: packages/editor-ui/src/live/LiveSignalContext.tsx:15

Properties

LiveSignalStoreDeps

Defined in: packages/editor-ui/src/live/live-signal-store.ts:37

Injected clock + scheduler so the store is deterministic and testable.

Methods

cancel()

cancel(handle): void;

Defined in: packages/editor-ui/src/live/live-signal-store.ts:40

Parameters

Returns

void

now()

now(): number;

Defined in: packages/editor-ui/src/live/live-signal-store.ts:38

Returns

number

schedule()

schedule(cb): number;

Defined in: packages/editor-ui/src/live/live-signal-store.ts:39

Parameters

Returns

number

NodeBodySlotProps

Defined in: packages/editor-ui/src/nodes/NodeBodySlot.tsx:11

Properties

NodeChromeProps

Defined in: packages/editor-ui/src/nodes/HlangNode.tsx:24

Presentational node chrome, decoupled from React Flow for easy testing.

Properties

NodeContextMenuController

Defined in: packages/editor-ui/src/context-menu/useNodeContextMenu.ts:19

Properties

Methods

close()

close(): void;

Defined in: packages/editor-ui/src/context-menu/useNodeContextMenu.ts:23

Returns

void

openForNode()

openForNode(screen, nodeId): void;

Defined in: packages/editor-ui/src/context-menu/useNodeContextMenu.ts:22

Open the menu for a node at a screen point.

Parameters

Returns

void

NodeContextMenuProps

Defined in: packages/editor-ui/src/context-menu/NodeContextMenu.tsx:36

Properties

NodeContextMenuState

Defined in: packages/editor-ui/src/context-menu/useNodeContextMenu.ts:12

Where the menu is open and which node it targets.

Properties

NodeInteraction

Defined in: packages/editor-ui/src/nodes/NodeInteractionContext.tsx:13

Methods

diagnosticFor()

diagnosticFor(id): Diagnostic | undefined;

Defined in: packages/editor-ui/src/nodes/NodeInteractionContext.tsx:15

The most severe diagnostic on a node, or undefined.

Parameters

Returns

Diagnostic | undefined

rename()

rename(id, name): void;

Defined in: packages/editor-ui/src/nodes/NodeInteractionContext.tsx:17

Commit a rename (host routes it through the command service).

Parameters

Returns

void

NodeInteractionProviderProps

Defined in: packages/editor-ui/src/nodes/NodeInteractionContext.tsx:27

Properties

NodeParamsHandle

Defined in: packages/editor-ui/src/hooks/useNodeParams.ts:11

Properties

Methods

setParam()

setParam(key, value): void;

Defined in: packages/editor-ui/src/hooks/useNodeParams.ts:15

Set a single param, committing an undoable UpdateParamsCommand.

Parameters

Returns

void

setParams()

setParams(next): void;

Defined in: packages/editor-ui/src/hooks/useNodeParams.ts:17

Replace the whole param bag, committing an undoable UpdateParamsCommand.

Parameters

Returns

void

NodeSearchController

Defined in: packages/editor-ui/src/command-palette/useNodeSearch.ts:37

The palette controller returned by the hook.

Properties

Methods

close()

close(): void;

Defined in: packages/editor-ui/src/command-palette/useNodeSearch.ts:45

Close the palette without creating anything.

Returns

void

commit()

commit(result): void;

Defined in: packages/editor-ui/src/command-palette/useNodeSearch.ts:53

Create the chosen node (and wire the pending link, if any), then close.

Parameters

Returns

void

openBlank()

openBlank(screen, flow): void;

Defined in: packages/editor-ui/src/command-palette/useNodeSearch.ts:41

Open the palette to create a free-standing node.

Parameters

Returns

void

openFromConnection()

openFromConnection(
   screen, 
   flow, 
   pending
): void;

Defined in: packages/editor-ui/src/command-palette/useNodeSearch.ts:43

Open the palette to complete a released connection.

Parameters

Returns

void

results()

results(query): readonly NodeSearchResultView[];

Defined in: packages/editor-ui/src/command-palette/useNodeSearch.ts:51

Rank registry descriptors for the current query and open mode. In blank mode every node is offered; in connection mode only nodes that can legally complete the pending link are offered.

Parameters

Returns

readonly NodeSearchResultView[]

NodeSearchProps

Defined in: packages/editor-ui/src/command-palette/NodeSearch.tsx:21

Properties

NodeSearchResultView

Defined in: packages/editor-ui/src/command-palette/useNodeSearch.ts:60

A ranked result as the palette renders it: the fuzzy match plus, in connection mode, the port on the new node that completes the link.

Properties

NodeSearchState

Defined in: packages/editor-ui/src/command-palette/useNodeSearch.ts:27

Where and how the palette is currently open.

Properties

NodeSearchTriggerOptions

Defined in: packages/editor-ui/src/command-palette/useNodeSearchTriggers.ts:35

Options for the trigger hook (injectable clock keeps it deterministic).

Properties

NodeSearchTriggers

Defined in: packages/editor-ui/src/command-palette/useNodeSearchTriggers.ts:43

Handlers to spread onto the <ReactFlow> element.

Properties

Methods

onPaneClick()

onPaneClick(event): void;

Defined in: packages/editor-ui/src/command-palette/useNodeSearchTriggers.ts:47

Attach to <ReactFlow onPaneClick>; a rapid second click opens the palette.

Parameters

Returns

void

OutlineTreeProps

Defined in: packages/editor-ui/src/panels/OutlineTree.tsx:26

Properties

ParamFieldBase

Defined in: packages/editor-ui/src/schema/param-field.ts:11

Common fields on every derived form field.

Properties

ParamFormProps

Defined in: packages/editor-ui/src/panels/ParamForm.tsx:14

Properties

PendingConnection

Defined in: packages/editor-ui/src/command-palette/node-search-model.ts:51

A connection left dangling in empty space. fromEndpoint is the port the user dragged from and fromPort its resolved descriptor; direction says whether that endpoint is the connection's source (an output, needing a target) or its target (an input, needing a source). The palette will create a node and wire the missing side.

Properties

PillNodeChromeProps

Defined in: packages/editor-ui/src/nodes/PillNode.tsx:27

Properties

PortRowProps

Defined in: packages/editor-ui/src/nodes/PortRow.tsx:11

Properties

PositionPanelProps

Defined in: packages/editor-ui/src/panels/PositionPanel.tsx:19

Properties

PreviewPanelProps

Defined in: packages/editor-ui/src/panels/PreviewPanel.tsx:12

Properties

RailTab

Defined in: packages/editor-ui/src/panels/RailTabs.tsx:12

Properties

RailTabsProps

Defined in: packages/editor-ui/src/panels/RailTabs.tsx:17

Properties

RunButtonProps

Defined in: packages/editor-ui/src/toolbar/Toolbar.tsx:69

Properties

ShortcutGroup

Defined in: packages/editor-ui/src/overlays/Cheatsheet.tsx:16

Properties

ShortcutRow

Defined in: packages/editor-ui/src/overlays/Cheatsheet.tsx:12

Properties

ToastApi

Defined in: packages/editor-ui/src/overlays/Toast.tsx:17

Methods

show()

show(message): void;

Defined in: packages/editor-ui/src/overlays/Toast.tsx:18

Parameters

Returns

void

ToastProviderProps

Defined in: packages/editor-ui/src/overlays/Toast.tsx:23

Properties

ToolbarProps

Defined in: packages/editor-ui/src/toolbar/Toolbar.tsx:13

Properties

ToolClusterProps

Defined in: packages/editor-ui/src/toolbar/ToolCluster.tsx:23

Properties

ToolItem

Defined in: packages/editor-ui/src/toolbar/ToolCluster.tsx:12

Properties

UndoRedoProps

Defined in: packages/editor-ui/src/toolbar/Toolbar.tsx:39

Properties

Type Aliases

CanvasMode

type CanvasMode = "select" | "pan";

Defined in: packages/editor-ui/src/canvas/CanvasDock.tsx:16

Interaction mode the canvas is in — left-drag selects, or left-drag pans.

NodeCandidate

type NodeCandidate = FuzzyCandidate<NodeDescriptor>;

Defined in: packages/editor-ui/src/command-palette/node-search-model.ts:24

A registry descriptor made searchable, keyed by its display name.

NodeLiveState

type NodeLiveState = "idle" | "active" | "error";

Defined in: packages/editor-ui/src/live/live-signal-store.ts:16

Live state of a node during execution.

NodeSearchResult

type NodeSearchResult = FuzzyResult<NodeDescriptor>;

Defined in: packages/editor-ui/src/command-palette/node-search-model.ts:27

A ranked search result carrying the matched descriptor.

ParamField

type ParamField = 
  | ParamFieldBase & object
  | ParamFieldBase & object
  | ParamFieldBase & object
  | ParamFieldBase & object
  | ParamFieldBase & object;

Defined in: packages/editor-ui/src/schema/param-field.ts:18

A discriminated union of the built-in form field types (zero any).

ThemeOverride

type ThemeOverride = Partial<Record<TokenName, string | undefined>>;

Defined in: packages/editor-ui/src/tokens/theme.ts:16

A partial override map from token name to CSS value. Values may be undefined (treated as "not overridden") so callers can pass conditional overrides without pre-filtering.

TokenName

type TokenName = typeof TOKEN_NAMES[number];

Defined in: packages/editor-ui/src/tokens/tokens.ts:42

A token name (without --), e.g. 'hl-silver'.

Variables

KIND_ROLE

const KIND_ROLE: Record<NodeKind, string>;

Defined in: packages/editor-ui/src/tokens/tokens.ts:57

Human-readable role label per node kind (used in node headers).

KIND_TOKEN

const KIND_TOKEN: Record<NodeKind, string>;

Defined in: packages/editor-ui/src/tokens/tokens.ts:50

Maps a node kind to its color-temperature token reference.

TOKEN_NAMES

const TOKEN_NAMES: readonly ["hl-void", "hl-void-2", "hl-surface", "hl-surface-2", "hl-line", "hl-line-strong", "hl-silver", "hl-silver-hi", "hl-silver-lo", "hl-spark", "hl-r", "hl-t", "hl-w", "hl-error", "hl-ink", "hl-ink-2", "hl-ink-3", "hl-font-ui", "hl-font-mono", "hl-r-sm", "hl-r-md", "hl-r-lg", "hl-r-pill", "hl-shadow-node", "hl-shadow-glass", "hl-glow-silver", "hl-ease"];

Defined in: packages/editor-ui/src/tokens/tokens.ts:11

The full set of token custom-property names (without the leading --).

Functions

AssetGrid()

function AssetGrid(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/panels/AssetGrid.tsx:24

Parameters

Returns

ReactElement

AssetNodeChrome()

function AssetNodeChrome(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/nodes/AssetNode.tsx:31

Parameters

Returns

ReactElement

CanvasChrome()

function CanvasChrome(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/canvas/CanvasChrome.tsx:17

Parameters

Returns

ReactElement

CanvasDock()

function CanvasDock(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/canvas/CanvasDock.tsx:79

Parameters

Returns

ReactElement

Cheatsheet()

function Cheatsheet(__namedParameters): 
  | ReactElement<unknown, string | JSXElementConstructor<any>>
  | null;

Defined in: packages/editor-ui/src/overlays/Cheatsheet.tsx:63

Parameters

Returns

| ReactElement<unknown, string | JSXElementConstructor<any>> | null

connectableCandidates()

function connectableCandidates(
   query, 
   descriptors, 
   pending, 
   validator
): readonly ConnectableResult[];

Defined in: packages/editor-ui/src/command-palette/node-search-model.ts:77

Filter and rank descriptors to those that can legally complete pending, annotating each with the completing port. Legality is decided by the core validator's model-free canLink (direction + DTO): for a dangling source we ask canLink(danglingSource, candidatePort); for a dangling target we ask canLink(candidatePort, danglingTarget). No graph model is consulted, because the candidate node does not exist yet — legality here is purely a property of the two ports.

Parameters

Returns

readonly ConnectableResult[]

createHlangFlowTypes()

function createHlangFlowTypes(): HlangFlowTypes;

Defined in: packages/editor-ui/src/nodes/flow-types.ts:31

Build the React Flow node/edge type maps for the hlang editor.

Returns

HlangFlowTypes

createTheme()

function createTheme(overrides): CSSProperties;

Defined in: packages/editor-ui/src/tokens/theme.ts:26

Build a style object that overrides the given tokens as inline custom properties. Apply it to a wrapping element to re-theme everything beneath.

<div style={createTheme({ 'hl-silver': '#d8dce4' })}> … </div>

Parameters

Returns

CSSProperties

deriveParamSchema()

function deriveParamSchema(descriptor, node): readonly ParamField[];

Defined in: packages/editor-ui/src/schema/param-field.ts:61

Derive the ordered form schema for a node. Keys come from the descriptor's defaultParams (the canonical param set); current values come from the live node, falling back to the default.

Parameters

Returns

readonly ParamField[]

descriptorCandidates()

function descriptorCandidates(descriptors): readonly NodeCandidate[];

Defined in: packages/editor-ui/src/command-palette/node-search-model.ts:30

Build fuzzy candidates from registry descriptors (display-name keyed).

Parameters

Returns

readonly NodeCandidate[]

DiagnosticBadge()

function DiagnosticBadge(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/panels/DiagnosticBadge.tsx:19

Parameters

Returns

ReactElement

EditorShell()

function EditorShell(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/shell/EditorShell.tsx:26

Parameters

Returns

ReactElement

EditorUIThemeProvider()

function EditorUIThemeProvider(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/tokens/ThemeProvider.tsx:19

Parameters

Returns

ReactElement

EmptyState()

function EmptyState(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/canvas/EmptyState.tsx:15

Parameters

Returns

ReactElement

FlowEdge()

function FlowEdge(props): ReactElement;

Defined in: packages/editor-ui/src/edges/FlowEdge.tsx:28

Parameters

Returns

ReactElement

fuzzyRank()

function fuzzyRank<T>(query, candidates): readonly FuzzyResult<T>[];

Defined in: packages/editor-ui/src/command-palette/fuzzy.ts:93

Rank candidates against a query, best first. Non-matching candidates are dropped. With an empty query, candidates are returned in their original order.

Type Parameters

Parameters

Returns

readonly FuzzyResult<T>[]

fuzzyScore()

function fuzzyScore(query, target): FuzzyMatch | null;

Defined in: packages/editor-ui/src/command-palette/fuzzy.ts:20

Score query against target as a case-insensitive subsequence match. Returns null when target does not contain query as a subsequence. An empty query matches everything with score 0 (stable, no reordering).

Parameters

Returns

FuzzyMatch | null

HlangNode()

function HlangNode(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/nodes/HlangNode.tsx:78

The React Flow node component. Reads everything from data.editorNode, then DISPATCHES to the right dressing — all in editor-ui, with no change to the runtime (every case is just a node with ports):

• an image asset (params.imageUrl) → AssetNodeChrome (framed photo)
• anything else → PillNodeChrome (nover capsule) The verbose port-board NodeChrome stays available as a future "expanded" view.

Parameters

Returns

ReactElement

InspectorPanel()

function InspectorPanel(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/panels/InspectorPanel.tsx:24

Parameters

Returns

ReactElement

isEditableTarget()

function isEditableTarget(target): boolean;

Defined in: packages/editor-ui/src/hooks/useEditorHotkeys.ts:24

True when focus is in an editable field, where shortcuts must NOT fire.

Parameters

Returns

boolean

LiveSignalProvider()

function LiveSignalProvider(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/live/LiveSignalContext.tsx:21

Parameters

Returns

ReactElement

NodeBodySlot()

function NodeBodySlot(__namedParameters): 
  | ReactElement<unknown, string | JSXElementConstructor<any>>
  | null;

Defined in: packages/editor-ui/src/nodes/NodeBodySlot.tsx:17

Parameters

Returns

| ReactElement<unknown, string | JSXElementConstructor<any>> | null

NodeChrome()

function NodeChrome(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/nodes/HlangNode.tsx:30

Parameters

Returns

ReactElement

NodeContextMenu()

function NodeContextMenu(__namedParameters): 
  | ReactElement<unknown, string | JSXElementConstructor<any>>
  | null;

Defined in: packages/editor-ui/src/context-menu/NodeContextMenu.tsx:42

Parameters

Returns

| ReactElement<unknown, string | JSXElementConstructor<any>> | null

NodeInteractionProvider()

function NodeInteractionProvider(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/nodes/NodeInteractionContext.tsx:32

Parameters

Returns

ReactElement

NodeSearch()

function NodeSearch(__namedParameters): 
  | ReactElement<unknown, string | JSXElementConstructor<any>>
  | null;

Defined in: packages/editor-ui/src/command-palette/NodeSearch.tsx:25

Parameters

Returns

| ReactElement<unknown, string | JSXElementConstructor<any>> | null

OutlineTree()

function OutlineTree(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/panels/OutlineTree.tsx:64

Parameters

Returns

ReactElement

ParamForm()

function ParamForm(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/panels/ParamForm.tsx:20

Parameters

Returns

ReactElement

PillNodeChrome()

function PillNodeChrome(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/nodes/PillNode.tsx:32

Parameters

Returns

ReactElement

PortRow()

function PortRow(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/nodes/PortRow.tsx:15

Parameters

Returns

ReactElement

PositionPanel()

function PositionPanel(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/panels/PositionPanel.tsx:45

Parameters

Returns

ReactElement

PreviewPanel()

function PreviewPanel(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/panels/PreviewPanel.tsx:18

Parameters

Returns

ReactElement

RailTabs()

function RailTabs(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/panels/RailTabs.tsx:23

Parameters

Returns

ReactElement

RunButton()

function RunButton(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/toolbar/Toolbar.tsx:81

Parameters

Returns

ReactElement

searchNodes()

function searchNodes(query, descriptors): readonly NodeSearchResult[];

Defined in: packages/editor-ui/src/command-palette/node-search-model.ts:37

Rank descriptors against query, best first (empty query keeps order).

Parameters

Returns

readonly NodeSearchResult[]

SignalBar()

function SignalBar(): ReactElement;

Defined in: packages/editor-ui/src/nodes/SignalBar.tsx:9

Returns

ReactElement

ToastProvider()

function ToastProvider(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/overlays/Toast.tsx:29

Parameters

Returns

ReactElement

tokenVar()

function tokenVar(name): string;

Defined in: packages/editor-ui/src/tokens/tokens.ts:45

var(--<name>) reference string for a token.

Parameters

Returns

string

Toolbar()

function Toolbar(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/toolbar/Toolbar.tsx:22

Parameters

Returns

ReactElement

ToolbarGhostButton()

function ToolbarGhostButton(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/toolbar/Toolbar.tsx:113

A secondary ghost button for the top bar (e.g. Invite). Presentational.

Parameters

Returns

ReactElement

ToolbarStat()

function ToolbarStat(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/toolbar/Toolbar.tsx:104

A compact read-only stat pill (e.g. a node/vertex count) for the top bar.

Parameters

Returns

ReactElement

ToolCluster()

function ToolCluster(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/toolbar/ToolCluster.tsx:27

Parameters

Returns

ReactElement

UndoRedo()

function UndoRedo(__namedParameters): ReactElement;

Defined in: packages/editor-ui/src/toolbar/Toolbar.tsx:43

Parameters

Returns

ReactElement

useEdgeFlowing()

function useEdgeFlowing(edgeId): boolean;

Defined in: packages/editor-ui/src/live/LiveSignalContext.tsx:42

Subscribe to a single edge's flowing state. False when no store is present.

Parameters

Returns

boolean

useEditorHotkeys()

function useEditorHotkeys(core, options?): void;

Defined in: packages/editor-ui/src/hooks/useEditorHotkeys.ts:50

Parameters

Returns

void

useLiveSignals()

function useLiveSignals(
   core, 
   handle, 
   explicitStore?
): void;

Defined in: packages/editor-ui/src/hooks/useLiveSignals.ts:24

Drive live visuals from an execution handle. Pass the handle returned by core.execution.run(...); pass undefined to clear. Keeps the store's edge index in sync with the model so a source-port pulse lights the right edges.

The store is taken from <LiveSignalProvider> context; pass explicitStore when the feeding component sits at or above the provider (so it and the subscribing components share one store).

Parameters

Returns

void

useLiveSignalStore()

function useLiveSignalStore(): LiveSignalStore | null;

Defined in: packages/editor-ui/src/live/LiveSignalContext.tsx:27

Access the live store, or null when there is no provider (visuals off).

Returns

LiveSignalStore | null

useNodeContextMenu()

function useNodeContextMenu(): NodeContextMenuController;

Defined in: packages/editor-ui/src/context-menu/useNodeContextMenu.ts:26

Returns

NodeContextMenuController

useNodeInteraction()

function useNodeInteraction(): NodeInteraction;

Defined in: packages/editor-ui/src/nodes/NodeInteractionContext.tsx:39

Returns

NodeInteraction

useNodeLiveState()

function useNodeLiveState(nodeId): NodeLiveState;

Defined in: packages/editor-ui/src/live/LiveSignalContext.tsx:32

Subscribe to a single node's live state. Idle when no store is present.

Parameters

Returns

NodeLiveState

useNodeParams()

function useNodeParams(core, nodeId): NodeParamsHandle;

Defined in: packages/editor-ui/src/hooks/useNodeParams.ts:20

Parameters

Returns

NodeParamsHandle

useNodeSearch()

function useNodeSearch(core): NodeSearchController;

Defined in: packages/editor-ui/src/command-palette/useNodeSearch.ts:66

Parameters

Returns

NodeSearchController

useNodeSearchTriggers()

function useNodeSearchTriggers(
   core, 
   search, 
   options?
): NodeSearchTriggers;

Defined in: packages/editor-ui/src/command-palette/useNodeSearchTriggers.ts:50

Parameters

Returns

NodeSearchTriggers

useToast()

function useToast(): ToastApi;

Defined in: packages/editor-ui/src/overlays/Toast.tsx:62

Returns

ToastApi