Skip to main content

ExtensionPanelRegistration

type ExtensionPanelRegistration = object;

This type represents the arguments you pass to ExtensionContext.registerPanel.

Properties​

name​

name: string;

Unique name of the panel within your extension

NOTE: Panel names within your extension must be unique. The panel name identifies this panel within a layout. Changing the panel name will cause layouts using the old name unable to load your panel.

initPanel​

initPanel: (context) => void | (() => void);

This function is invoked when your panel is initialized

Parameters​

ParameterType
contextPanelExtensionContext

Returns​

void | (() => void)

(optional) A function which will be called when the panel is removed or replaced. Perform any cleanup logic here to gracefully tear down your panel.