API for `rete-angular-plugin` package

Produces

Signals that can be emitted by the plugin

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

Parameter	Extends	Description
Schemes	`BaseSchemes`

AngularPlugin

src/core.ts

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

class AngularPlugin<Schemes extends BaseSchemes, T extends unknown>

Parameter	Extends	Description
Schemes	`BaseSchemes`
T	`unknown`

Extends Scope<Produces, Requires | T>

Emits connectionpath

Listens render unmount

constructor

src/core.ts

constructor(params: { injector: Injector }): AngularPlugin<Schemes, T>

Parameter	Type	Description
params	`{ injector: Injector }`	Plugin properties

Returns AngularPlugin<Schemes, T>

addPreset

src/core.ts

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

Parameter	Type	Description
preset	`RenderPreset<Schemes, CanAssignEachTupleElemmentToAnyOf<T, UnionToTuple<K>> extends true ? K : "Cannot apply preset. Provided signals are not compatible">`	Preset that can render nodes, connections and other elements.

Returns void

Presets

src/presets/index.ts

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

classic

src/presets/classic/index.ts

setup

src/presets/classic/index.ts

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

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

Parameter	Type	Description
props	`ClassicProps<Schemes, K>`

Returns RenderPreset<Schemes, K>

contextMenu

src/presets/context-menu/index.ts

setup

src/presets/context-menu/index.ts

Preset for rendering context menu.

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

Parameter	Type	Description
props	`{ delay: number }`

Returns RenderPreset<Schemes, K>

minimap

src/presets/minimap/index.ts

setup

src/presets/minimap/index.ts

Preset for rendering minimap.

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

Parameter	Type	Description
props	`{ size: number }`

Returns RenderPreset<Schemes, K>

reroute

src/presets/reroute/index.ts

setup

src/presets/reroute/index.ts

Preset for rendering pins.

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

Parameter	Type	Description
props	`Props`

Returns RenderPreset<Schemes, K>

Documentation

API for rete-angular-plugin package

API for `rete-angular-plugin` package