WorkspaceTemplate

Defined in: namespaces.ts:1243

A workspace template describing an entire window layout.

Properties

schemaVersion

schemaVersion: number

Defined in: namespaces.ts:1245

Schema version (starts at 1).

---

id

id: string

Defined in: namespaces.ts:1247

Unique identifier.

---

name

name: string

Defined in: namespaces.ts:1249

Human-readable display name.

---

description?

optional description?: string

Defined in: namespaces.ts:1251

Optional long description.

---

icon?

optional icon?: string

Defined in: namespaces.ts:1253

SF Symbol name for the workspace icon.

---

accentColor?

optional accentColor?: string

Defined in: namespaces.ts:1255

Hex color string for accent tinting.

---

author?

optional author?: string

Defined in: namespaces.ts:1257

Author attribution.

---

requires?

optional requires?: string[]

Defined in: namespaces.ts:1259

Plugin IDs this workspace depends on.

---

sidebar?

optional sidebar?: WorkspaceTemplateSidebarConfig

Defined in: namespaces.ts:1261

Sidebar configuration.

---

leftPane?

optional leftPane?: WorkspaceTemplatePaneConfig

Defined in: namespaces.ts:1263

Left pane layout.

---

rightPane?

optional rightPane?: WorkspaceTemplatePaneConfig

Defined in: namespaces.ts:1265

Right pane layout.

---

variables?

optional variables?: Record<string, WorkspaceTemplateVariable>

Defined in: namespaces.ts:1267

User-prompted variables (keyed by variable name).

---

source

source: WorkspaceTemplateSource

Defined in: namespaces.ts:1269

Where this workspace came from.