API for rete-context-menu-plugin package

ContextMenuExtra

index.ts

Signal types produced by ContextMenuPlugin instance

type ContextMenuExtra = RenderSignal<
  "contextmenu",
  { items: Item[]; searchBar: boolean; onHide: unknown }
>;

ContextMenuPlugin

index.ts

Plugin for context menu. Responsible for initialing rendering of context menu with predefined items.

class ContextMenuPlugin<Schemes extends BaseSchemes>

Extends Scope<never, Requires<Schemes> | ContextMenuExtra>

Emits render unmount

Listens unmount contextmenu pointerdown

constructor

index.ts

constructor(props: Props<Schemes>): ContextMenuPlugin<Schemes>

Returns ContextMenuPlugin<Schemes>

Props

index.ts

Context menu plugin props

type Props<Schemes extends BaseSchemes> = {
  delay: number;
  items: Items<Schemes>;
};

Presets

presets/index.ts

Presets that create items for root and node specific context menu.

classic

presets/classic/index.ts

setup

presets/classic/index.ts

Classic context menu preset. Configures nodes/actions items for root and Delete/Clone items for nodes

setup(nodes: ItemDefinition<Schemes>[]): Items<Schemes>

Examples

Presets.classic.setup([
 ["Math", [
   ["Number", () => new NumberNode()],
 ]]
])

Returns Items<Schemes>