Skip to content

Interface: ToolDef ​

Defined in: core/dist/plugin.d.ts:95

UI contribution. Consumed by @sealpixel/ui, which calls the functions with its UiToolContext. Parameters are typed never here so a plugin can declare the context shape it needs without depending on the UI package.

Properties ​

activate? ​

optional activate?: (ctx) => void

Defined in: core/dist/plugin.d.ts:102

Parameters ​

ctx ​

never

Returns ​

void


deactivate? ​

optional deactivate?: (ctx) => void

Defined in: core/dist/plugin.d.ts:103

Parameters ​

ctx ​

never

Returns ​

void


icon ​

icon: unknown

Defined in: core/dist/plugin.d.ts:97


id? ​

optional id?: string

Defined in: core/dist/plugin.d.ts:96


label ​

label: string

Defined in: core/dist/plugin.d.ts:99

i18n key or literal label.


overlay? ​

optional overlay?: (ctx) => unknown

Defined in: core/dist/plugin.d.ts:101

Parameters ​

ctx ​

never

Returns ​

unknown


panel ​

panel: (ctx) => unknown

Defined in: core/dist/plugin.d.ts:100

Parameters ​

ctx ​

never

Returns ​

unknown


preview? ​

optional preview?: (ctx) => PreviewHint

Defined in: core/dist/plugin.d.ts:105

Parameters ​

ctx ​

never

Returns ​

PreviewHint


shortcuts? ​

optional shortcuts?: Record<string, (ctx) => void>

Defined in: core/dist/plugin.d.ts:104