WorkspaceTemplate

Defined in: namespaces.ts:1242

A workspace template describing an entire window layout.

Properties

schemaVersion

schemaVersion: number

Defined in: namespaces.ts:1244

Schema version (starts at 1).

---

id

id: string

Defined in: namespaces.ts:1246

Unique identifier.

---

name

name: string

Defined in: namespaces.ts:1248

Human-readable display name.

---

description?

optional description?: string

Defined in: namespaces.ts:1250

Optional long description.

---

icon?

optional icon?: string

Defined in: namespaces.ts:1252

SF Symbol name for the workspace icon.

---

accentColor?

optional accentColor?: string

Defined in: namespaces.ts:1254

Hex color string for accent tinting.

---

author?

optional author?: string

Defined in: namespaces.ts:1256

Author attribution.

---

requires?

optional requires?: string[]

Defined in: namespaces.ts:1258

Plugin IDs this workspace depends on.

---

sidebar?

optional sidebar?: WorkspaceTemplateSidebarConfig

Defined in: namespaces.ts:1260

Sidebar configuration.

---

leftPane?

optional leftPane?: WorkspaceTemplatePaneConfig

Defined in: namespaces.ts:1262

Left pane layout.

---

rightPane?

optional rightPane?: WorkspaceTemplatePaneConfig

Defined in: namespaces.ts:1264

Right pane layout.

---

variables?

optional variables?: Record<string, WorkspaceTemplateVariable>

Defined in: namespaces.ts:1266

User-prompted variables (keyed by variable name).

---

source

source: WorkspaceTemplateSource

Defined in: namespaces.ts:1268

Where this workspace came from.