Types

Import these from @grafloria/renderer.

Types

AnchorFn

ts
Copy
type AnchorFn = (ctx: AnchorContext) => AnchorResult;

BuiltinToolId

The built-in gesture tools, by name. A registration may REPLACE any of them.

ts
Copy
type BuiltinToolId = 'select' | 'node-drag' | 'link-draw' | 'marquee' | 'pan';

CapabilityName

The names an extension may request. Mirrors the keys of {@link ExtensionCapabilities}.

ts
Copy
type CapabilityName =
  | 'shapes'
  | 'links'
  | 'routers'
  | 'templates'
  | 'animations'
  | 'tools'
  | 'panels';

ConnectionPointFn

Return null to decline and fall through to the default pipeline.

ts
Copy
type ConnectionPointFn = (ctx: ConnectionPointContext) => ConnectionPointResult | null;

ConnectionValidator

Return false (or a reason string) to veto.

ts
Copy
type ConnectionValidator = (candidate: ConnectionCandidate) => boolean | string;

ConnectorFn

Must return a complete SVG path d.

ts
Copy
type ConnectorFn = (ctx: ConnectorContext) => string;

Disposer

The universal teardown handle. Idempotent by contract.

ts
Copy
type Disposer = () => void;

ExtSide

ts
Copy
type ExtSide = 'left' | 'right' | 'top' | 'bottom';

LazyExtension

A lazily-loaded extension: nothing is imported until activate(id).

ts
Copy
type LazyExtension<C extends CapabilityName = CapabilityName> = () => Promise<
  Extension<C> | { default: Extension<C> }
>;

NodeComponentRegistry

type → component.

ts
Copy
type NodeComponentRegistry = Record<string, NodeComponent<never>>;

NodeRenderFn

A component's render function.

Return a VNode to have the renderer patch it (the framework-agnostic path), or take the HTMLElement and own it yourself (the React/Angular/Vue path — mount a portal into it and return void).

ts
Copy
type NodeRenderFn<D = Record<string, unknown>> = (
  props: NodeComponentProps<D>,
  element: HTMLElement
) => VNode | void;

PortalPlacement

Corner placements for a screen-space portal.

ts
Copy
type PortalPlacement =
  | 'top-left'
  | 'top-right'
  | 'bottom-left'
  | 'bottom-right'
  | 'top-center'
  | 'bottom-center'
  | 'center'
  /** No positioning at all — you own `style`/`class`. */
  | 'none';

Selector

ts
Copy
type Selector<T> = (snapshot: DiagramSnapshot) => T;

ToolId

ts
Copy
type ToolId = BuiltinToolId | (string & {});