Skip to content

openrv-web / UIPanelContribution

Interface: UIPanelContribution

Defined in: plugin/types.ts:195

UI Panel contribution: a panel that can be mounted into the application layout.

Properties

icon?

optional icon: string

Defined in: plugin/types.ts:203

Icon identifier or SVG string


id

id: string

Defined in: plugin/types.ts:197

Unique panel ID


label

label: string

Defined in: plugin/types.ts:199

Display label


location

location: "left" | "right" | "bottom" | "floating"

Defined in: plugin/types.ts:201

Where the panel can be docked

Methods

destroy()?

optional destroy(): void

Defined in: plugin/types.ts:207

Cleanup when panel is removed

Returns

void


render()

render(container, context): void

Defined in: plugin/types.ts:205

Create the panel's DOM content

Parameters

container

HTMLElement

context

PluginContext

Returns

void

Released under the MIT License.