Skip to content

PanelOptions

Defined in: namespaces.ts:201

Options for structured panel registration.

title: string

Defined in: namespaces.ts:203

Display title for the panel.


optional icon?: SFSymbolName

Defined in: namespaces.ts:205

SF Symbol name for the panel icon.


optional target?: "sidebar" | "pane"

Defined in: namespaces.ts:207

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


optional position?: "top" | "bottom"

Defined in: namespaces.ts:209

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


view: ViewDescriptor

Defined in: namespaces.ts:211

JSON view descriptor for the panel content.


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

Defined in: namespaces.ts:213

Handler function invoked for interactive elements.

string

void | Promise<void>


optional priority?: number

Defined in: namespaces.ts:215

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


optional autoShow?: boolean

Defined in: namespaces.ts:220

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