Interface PluginApi

Context passed to plugin callbacks.

interface PluginApi {
    editor: EditorCore | null;
    engine: DotloomEngine;
    on: <K extends keyof EventMap>(name: K, cb: Listener<K>) => () => void;
    pluginId: string;
    onDispose(fn: () => void): void;
}

Index

Properties

editor engine on pluginId

Methods

Properties

`Readonly`editor

editor: EditorCore | null

`Readonly`engine

engine: DotloomEngine

on

on: <K extends keyof EventMap>(name: K, cb: Listener<K>) => () => void

Subscribe to engine events; removed automatically when the plugin is disabled.

Type Declaration

- <K extends keyof EventMap>(name: K, cb: Listener<K>): () => void
- Subscribe to an event; returns an unsubscribe function.
  Type Parameters
  - K extends keyof EventMap
  Parameters
  - name: K
  - cb: Listener<K>
  Returns () => void

`Readonly`pluginId

pluginId: string

Methods

onDispose

onDispose(fn: () => void): void
Register a cleanup run on disable/unregister (GPU resources, DOM, timers).
Parameters
- fn: () => void
Returns void
- Defined in packages/sdk/src/plugins.ts:34