artboard-deluxe

Appearance

artboard-deluxe / ArtboardPluginInstance

ArtboardPluginInstance<O, R> ​

ArtboardPluginInstance<O, R> = object & R

Defined in: types/index.ts:42

A fully initialised plugin instance.

Type declaration ​

destroy()? ​

optional destroy: () => void

Remove event listeners and clean up.

Returns ​

void

loop()? ​

optional loop: (ctx) => void

Called in the main animation loop.

Receives the state of the artboard at the time of the animation loop as an argument.

Parameters ​

ctx ​

ArtboardLoopContext

Returns ​

void

options ​

options: ArtboardPluginOptions<O>

The options helper.

Type Parameters ​

O ​

O extends object = object

R ​

R extends object = object