Skip to content

openrv-web / UIPanelContribution

Interface: UIPanelContribution

Defined in: plugin/types.ts:196

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

Properties

icon?

optional icon: string

Defined in: plugin/types.ts:204

Icon identifier or SVG string


id

id: string

Defined in: plugin/types.ts:198

Unique panel ID


label

label: string

Defined in: plugin/types.ts:200

Display label


location

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

Defined in: plugin/types.ts:202

Where the panel can be docked

Methods

destroy()?

optional destroy(): void

Defined in: plugin/types.ts:208

Cleanup when panel is removed

Returns

void


render()

render(container, context): void

Defined in: plugin/types.ts:206

Create the panel's DOM content

Parameters

container

HTMLElement

context

PluginContext

Returns

void

Released under the MIT License.