Skip to content
AppOS Plugin SDK

PanelOptions

Defined in: namespaces.ts:202

Options for structured panel registration.

Properties

Section titled “Properties”

title

Section titled “title”

title: string

Defined in: namespaces.ts:204

Display title for the panel.

icon?

Section titled “icon?”

optional icon?: SFSymbolName

Defined in: namespaces.ts:206

SF Symbol name for the panel icon.

target?

Section titled “target?”

optional target?: "sidebar" | "pane"

Defined in: namespaces.ts:208

Target region: “sidebar” or “pane”. Default: “sidebar”.

position?

Section titled “position?”

optional position?: "top" | "bottom"

Defined in: namespaces.ts:210

Position hint: “top” or “bottom” (for sidebar). Default: “bottom”.

view

Section titled “view”

view: ViewDescriptor

Defined in: namespaces.ts:212

JSON view descriptor for the panel content.

handler?

Section titled “handler?”

optional handler?: (action) => void | Promise<void>

Defined in: namespaces.ts:214

Handler function invoked for interactive elements.

Parameters

Section titled “Parameters”
action
Section titled “action”

string

Returns

Section titled “Returns”

void | Promise<void>

priority?

Section titled “priority?”

optional priority?: number

Defined in: namespaces.ts:216

Priority for ordering (100+ for plugins, lower = higher priority).

autoShow?

Section titled “autoShow?”

optional autoShow?: boolean

Defined in: namespaces.ts:221

Whether the panel should auto-show in a pane tab on first registration. Only applies when target is "pane". Default: true.