API for @retejs/lit-plugin package

LitPlugin

index.tsx

React plugin. Renders nodes, connections and other elements using React.

class LitPlugin<Schemes extends BaseSchemes, T extends unknown>

Extends Scope<Produces, Requires | T>

Emits connectionpath

Listens render unmount

addPreset

index.tsx

Adds a preset to the plugin.

addPreset(preset: RenderPreset<Schemes, CanAssignEachTupleElemmentToAnyOf<T, UnionToTuple<K>> extends true ? K : "Cannot apply preset. Provided signals are not compatible">): void

Returns void

Produces

index.tsx

Signals that can be emitted by the plugin

type Produces<Schemes extends BaseSchemes> = {
  data: Object;
  type: "connectionpath";
};

Presets

presets/index.ts

Built-in presets, responsible for rendering different parts of the editor.

classic

presets/classic/index.tsx

setup

presets/classic/index.tsx

Classic preset for rendering nodes, connections, controls and sockets.

setup(props: ClassicProps<Schemes, K>): RenderPreset<Schemes, K>

Returns RenderPreset<Schemes, K>

contextMenu

presets/context-menu/index.ts

setup

presets/context-menu/index.ts

Preset for rendering context menu.

setup(props: { delay: number }): RenderPreset<Schemes, K>

Returns RenderPreset<Schemes, K>

minimap

presets/minimap/index.ts

setup

presets/minimap/index.ts

Preset for rendering minimap.

setup(props: { size: number }): RenderPreset<Schemes, K>

Returns RenderPreset<Schemes, K>

reroute

presets/reroute/index.ts

setup

presets/reroute/index.ts

Preset for rendering pins.

setup(props: Props): RenderPreset<Schemes, K>

Returns RenderPreset<Schemes, K>