Skip to content

@serenity-is/sleekgrid / IPlugin

Interface: IPlugin

Defined in: src/core/grid-plugin.ts:22

Legacy alias for GridPlugin.

Deprecated

Use GridPlugin instead.

Extends

Properties

destroy()?

optional destroy: () => void

Defined in: src/core/grid-plugin.ts:15

Optional teardown hook; called when the grid or plugin is unregistered.

Returns

void

Inherited from

GridPlugin.destroy


pluginName?

optional pluginName: string

Defined in: src/core/grid-plugin.ts:13

Optional unique name used by GridPluginHost.getPluginByName for lookup.

Inherited from

GridPlugin.pluginName

Methods

init()

init(grid): void

Defined in: src/core/grid-plugin.ts:11

Called by the grid when the plugin is registered.

Parameters

grid

ISleekGrid

Host grid instance the plugin attaches to.

Returns

void

Inherited from

GridPlugin.init