Interface: PanelPlugin

Defined in: panel/plugin.ts:41

The settings panel plugin. The plugin instance opens and closes the panel.

Extends

• Plugin<"panel", PanelSchema>

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
isOpen	readonly	boolean	True while the panel is open.	-	panel/plugin.ts:43
name	readonly	"panel"	The unique name of the section. It is the key in the configuration document.	Plugin.name	config/types.ts:56
schema	readonly	S	The fields of the section.	Plugin.schema	config/types.ts:58

Methods

close()

close(): void;

Defined in: panel/plugin.ts:47

Hide the panel.

Returns

void

---

configure()?

optional configure(config, theme): void;

Defined in: core/types.ts:139

Gets the resolved values of the section after each change. The engine does not call it while enabled is false.

Parameters

Parameter	Type
config	EffectConfig<S>
theme	ThemeConfig

Returns

void

Inherited from

Plugin.configure

---

destroy()?

optional destroy(): void;

Defined in: core/types.ts:141

Releases all resources.

Returns

void

Inherited from

Plugin.destroy

---

open()

open(): Promise<void>;

Defined in: panel/plugin.ts:45

Load Tweakpane if necessary, then show the panel.

Returns

Promise<void>

---

setup()

setup(context): void;

Defined in: core/types.ts:137

Gets the services of the engine. The engine calls it one time.

Parameters

Parameter	Type
context	PluginContext

Returns

void

Inherited from

Plugin.setup

---

toggle()

toggle(): Promise<void>;

Defined in: panel/plugin.ts:49

Close the panel if it is open. Otherwise, open the panel.

Returns

Promise<void>