Skip to content

aninest root / Mode / Mode

Mode

ts
type Mode: object;

Provides on, off, and toggle functions to toggle an ExtensionStack.`

Type declaration

off()

ts
off: () => void;

Returns

void

on()

ts
on: () => void;

Returns

void

toggle()

ts
toggle: (to?) => void;

Will toggle the mode on or off depending on the value of to. If the mode is already set to match to then this function is a no-op.

Parameters

to?: boolean

true to turn the mode on, false to turn the mode off, and undefined to toggle.

Returns

void

Defined in

Animate/Mode.ts:12