@serenity-is/sleekgrid / GridPlugin

Interface: GridPlugin

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

Contract for grid plugins (e.g. selection models, overlays).

Extended by

• IPlugin
• SelectionModel

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

---

pluginName?

optional pluginName: string

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

Optional unique name used by GridPluginHost.getPluginByName for lookup.

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