Skip to content

Function: panelPlugin() ​

ts
function panelPlugin(options?): PanelPlugin;

Defined in: panel/plugin.ts:130

Create a plugin that shows a settings panel with Tweakpane 4. The plugin loads Tweakpane when the panel opens for the first time.

Parameters ​

ParameterTypeDescription
optionsPanelPluginOptionsThe loader, the triggers, the nonce, the container, the title and the expanded sections.

Returns ​

PanelPlugin

The plugin with the name panel. Use open(), close() and toggle() to control the panel.

Example ​

ts
const panel = panelPlugin({ hotkey: 'Alt+Shift+W', launcher: true });
createWand({ plugins: [panel] });
await panel.open();