quilt-vanilla / Class: Workspace<State>

Defined in: packages/dom/src/workspace-api.ts:210

A mounted workspace. Call dispose once when its application container is removed.

Type Parameters

State

State = unknown

Implements

• WorkspaceHandle<State>

Constructors

Constructor

new Workspace<State>(options): Workspace<State>

Defined in: packages/dom/src/workspace-api.ts:223

Parameters

options

WorkspaceOptions<State>

Returns

Workspace<State>

Accessors

isDisposed

Get Signature

get isDisposed(): boolean

Defined in: packages/dom/src/workspace-api.ts:309

Returns

boolean

Implementation of

WorkspaceHandle.isDisposed

Methods

activatePane()

activatePane(id): void

Defined in: packages/dom/src/workspace-api.ts:560

Parameters

id

string

Returns

void

Implementation of

WorkspaceHandle.activatePane

---

addPane()

addPane(type, options?): PaneHandle | undefined

Defined in: packages/dom/src/workspace-api.ts:524

Create from a registered type; undefined means its factory cancelled.

Parameters

type

string

options?

AddPaneOptions = {}

Returns

PaneHandle | undefined

Implementation of

WorkspaceHandle.addPane

---

can()

can(paneId, capability): boolean

Defined in: packages/dom/src/workspace-api.ts:617

Parameters

paneId

string

capability

Capability

Returns

boolean

Implementation of

WorkspaceHandle.can

---

canExecuteAction()

canExecuteAction(action, context?): boolean

Defined in: packages/dom/src/workspace-api.ts:356

Parameters

action

CommandId

context?

ActionContext

Returns

boolean

Implementation of

WorkspaceHandle.canExecuteAction

---

canNode()

canNode(nodeId, capability): boolean

Defined in: packages/dom/src/workspace-api.ts:621

Parameters

nodeId

string

capability

Capability

Returns

boolean

Implementation of

WorkspaceHandle.canNode

---

canRestoreClosedPane()

canRestoreClosedPane(): boolean

Defined in: packages/dom/src/workspace-api.ts:625

Returns

boolean

Implementation of

WorkspaceHandle.canRestoreClosedPane

---

closeGroup()

closeGroup(id, options?): Promise<boolean>

Defined in: packages/dom/src/workspace-api.ts:649

Parameters

id

string

options?

CloseOptions = {}

Returns

Promise<boolean>

Implementation of

WorkspaceHandle.closeGroup

---

closePane()

closePane(id, options?): Promise<boolean>

Defined in: packages/dom/src/workspace-api.ts:641

Confirm and check permissions unless force is explicitly supplied.

Parameters

id

string

options?

CloseOptions = {}

Returns

Promise<boolean>

Implementation of

WorkspaceHandle.closePane

---

dedicateGroup()

dedicateGroup(id): Promise<boolean>

Defined in: packages/dom/src/workspace-api.ts:629

Parameters

id

string

Returns

Promise<boolean>

Implementation of

WorkspaceHandle.dedicateGroup

---

dispose()

dispose(): void

Defined in: packages/dom/src/workspace-api.ts:669

Idempotently cancel pending work and release views, companions, and the private model.

Returns

void

Implementation of

WorkspaceHandle.dispose

---

executeAction()

executeAction(action, context?): Promise<boolean>

Defined in: packages/dom/src/workspace-api.ts:359

Parameters

action

CommandId

context?

ActionContext

Returns

Promise<boolean>

Implementation of

WorkspaceHandle.executeAction

---

exportLayout()

exportLayout(): LayoutSnapshot

Defined in: packages/dom/src/workspace-api.ts:328

Mutable arrangement copy. Use exportWorkspace for persistence with appearance.

Returns

LayoutSnapshot

Implementation of

WorkspaceHandle.exportLayout

---

exportWorkspace()

exportWorkspace(): WorkspacePreset

Defined in: packages/dom/src/workspace-api.ts:339

Returns

WorkspacePreset

Implementation of

WorkspaceHandle.exportWorkspace

---

getAutoCollapse()

getAutoCollapse(): AutoCollapse

Defined in: packages/dom/src/workspace-api.ts:456

Returns

AutoCollapse

Implementation of

WorkspaceHandle.getAutoCollapse

---

getCommands()

getCommands(): readonly RegisteredCommand[]

Defined in: packages/dom/src/workspace-api.ts:368

Immutable metadata for registered application commands.

Returns

readonly RegisteredCommand[]

Implementation of

WorkspaceHandle.getCommands

---

getLayout()

getLayout(): LayoutSnapshot

Defined in: packages/dom/src/workspace-api.ts:324

Stable immutable layout snapshot.

Returns

LayoutSnapshot

Implementation of

WorkspaceHandle.getLayout

---

getPane()

getPane(id): PaneHandle | undefined

Defined in: packages/dom/src/workspace-api.ts:466

Parameters

id

string

Returns

PaneHandle | undefined

Implementation of

WorkspaceHandle.getPane

---

getPanes()

getPanes(): PaneHandle[]

Defined in: packages/dom/src/workspace-api.ts:521

Returns

PaneHandle[]

Implementation of

WorkspaceHandle.getPanes

---

getShortcutConflicts()

getShortcutConflicts(): readonly ShortcutConflict[]

Defined in: packages/dom/src/workspace-api.ts:365

All same-workspace collisions, including externally handled bindings.

Returns

readonly ShortcutConflict[]

Implementation of

WorkspaceHandle.getShortcutConflicts

---

getShortcuts()

getShortcuts(): readonly RegisteredShortcut[]

Defined in: packages/dom/src/workspace-api.ts:362

Returns

readonly RegisteredShortcut[]

Implementation of

WorkspaceHandle.getShortcuts

---

insertPane()

insertPane(pane, groupId, options?): void

Defined in: packages/dom/src/workspace-api.ts:552

Insert a fully specified serializable record (advanced model integration).

Parameters

pane

Pane

groupId

string

options?

CommandOptions = {}

Returns

void

Implementation of

WorkspaceHandle.insertPane

---

joinGroup()

joinGroup(groupId, options?): void

Defined in: packages/dom/src/workspace-api.ts:589

Parameters

groupId

string

options?

CommandOptions = {}

Returns

void

Implementation of

WorkspaceHandle.joinGroup

---

joinGroups()

joinGroups(receiverId, otherId, options?): void

Defined in: packages/dom/src/workspace-api.ts:593

Parameters

receiverId

string

otherId

string

options?

JoinOptions = {}

Returns

void

Implementation of

WorkspaceHandle.joinGroups

---

loadLayout()

loadLayout(input): void

Defined in: packages/dom/src/workspace-api.ts:332

Validate and replace the arrangement; detached records restore docked. Invalidates old pane handles on success.

Parameters

input

unknown

Returns

void

Implementation of

WorkspaceHandle.loadLayout

---

loadWorkspace()

loadWorkspace(input): void

Defined in: packages/dom/src/workspace-api.ts:343

Apply a complete preset atomically; emit one consolidated change event.

Parameters

input

unknown

Returns

void

Implementation of

WorkspaceHandle.loadWorkspace

---

maximize()

maximize(groupId, options?): void

Defined in: packages/dom/src/workspace-api.ts:605

Parameters

groupId

string | null

options?

CommandOptions = {}

Returns

void

Implementation of

WorkspaceHandle.maximize

---

movePane()

movePane(paneId, groupId, position?, index?, options?): void

Defined in: packages/dom/src/workspace-api.ts:566

Parameters

paneId

string

groupId

string

position?

"top" | "left" | "tab" | "right" | "bottom"

index?

number

options?

CommandOptions = {}

Returns

void

Implementation of

WorkspaceHandle.movePane

---

on()

on<K>(event, listener): () => void

Defined in: packages/dom/src/workspace-api.ts:312

Subscribe to configuration changes or errors. The returned function unsubscribes.

Type Parameters

K

K extends keyof WorkspaceEvents

Parameters

event

K

listener

(event) => void

Returns

() => void

Implementation of

WorkspaceHandle.on

---

popout()

popout(id, placement?): Promise<boolean>

Defined in: packages/dom/src/workspace-api.ts:657

Call during a user gesture. Resolves after destination readiness or rollback.

Parameters

id

string

placement?

WindowPlacement

Returns

Promise<boolean>

Implementation of

WorkspaceHandle.popout

---

refreshTheme()

refreshTheme(): void

Defined in: packages/dom/src/workspace-api.ts:452

Returns

void

Implementation of

WorkspaceHandle.refreshTheme

---

registerCommand()

registerCommand(command): () => void

Defined in: packages/dom/src/workspace-api.ts:389

Register a unique application command; cleanup removes it and its bindings.

Parameters

command

CommandRegistration

Returns

() => void

Implementation of

WorkspaceHandle.registerCommand

---

registerShortcut()

registerShortcut(action, registration): () => void

Defined in: packages/dom/src/workspace-api.ts:381

Replace one binding. Cleanup removes only this registration, without restoring an older binding.

Parameters

action

CommandId

registration

ShortcutRegistration

Returns

() => void

Implementation of

WorkspaceHandle.registerShortcut

---

releaseGroup()

releaseGroup(id): void

Defined in: packages/dom/src/workspace-api.ts:633

Parameters

id

string

Returns

void

Implementation of

WorkspaceHandle.releaseGroup

---

removeEmptyGroup()

removeEmptyGroup(groupId): void

Defined in: packages/dom/src/workspace-api.ts:585

Parameters

groupId

string

Returns

void

Implementation of

WorkspaceHandle.removeEmptyGroup

---

reset()

reset(): void

Defined in: packages/dom/src/workspace-api.ts:336

Restore the initial arrangement and appearance.

Returns

void

Implementation of

WorkspaceHandle.reset

---

resize()

resize(splitId, ratio, options?): void

Defined in: packages/dom/src/workspace-api.ts:597

Parameters

splitId

string

ratio

number

options?

CommandOptions = {}

Returns

void

Implementation of

WorkspaceHandle.resize

---

resizeMany()

resizeMany(ratios, options?): void

Defined in: packages/dom/src/workspace-api.ts:601

Parameters

ratios

Record<string, number>

options?

CommandOptions = {}

Returns

void

Implementation of

WorkspaceHandle.resizeMany

---

restoreClosedPane()

restoreClosedPane(): void

Defined in: packages/dom/src/workspace-api.ts:637

Returns

void

Implementation of

WorkspaceHandle.restoreClosedPane

---

retryPane()

retryPane(id): void

Defined in: packages/dom/src/workspace-api.ts:665

Parameters

id

string

Returns

void

Implementation of

WorkspaceHandle.retryPane

---

returnPane()

returnPane(id): void

Defined in: packages/dom/src/workspace-api.ts:661

Parameters

id

string

Returns

void

Implementation of

WorkspaceHandle.returnPane

---

setAutoCollapse()

setAutoCollapse(mode): void

Defined in: packages/dom/src/workspace-api.ts:460

Parameters

mode

AutoCollapse

Returns

void

Implementation of

WorkspaceHandle.setAutoCollapse

---

setTabBar()

setTabBar(tabBar): void

Defined in: packages/dom/src/workspace-api.ts:449

Parameters

tabBar

TabBarOptions

Returns

void

Implementation of

WorkspaceHandle.setTabBar

---

setTabDisplay()

setTabDisplay(groupId, display): void

Defined in: packages/dom/src/workspace-api.ts:609

Parameters

groupId

string

display

"automatic" | "compact" | undefined

Returns

void

Implementation of

WorkspaceHandle.setTabDisplay

---

setTabPlacement()

setTabPlacement(groupId, placement): void

Defined in: packages/dom/src/workspace-api.ts:613

Parameters

groupId

string

placement

"top" | "left" | undefined

Returns

void

Implementation of

WorkspaceHandle.setTabPlacement

---

setTheme()

setTheme(theme): void

Defined in: packages/dom/src/workspace-api.ts:446

Parameters

theme

LayoutTheme

Returns

void

Implementation of

WorkspaceHandle.setTheme

---

splitGroup()

splitGroup(groupId, axis, pane?, options?): string

Defined in: packages/dom/src/workspace-api.ts:576

Parameters

groupId

string

axis

Axis

pane?

Pane | null

options?

CommandOptions & object = {}

Returns

string

Implementation of

WorkspaceHandle.splitGroup

---

updateOptions()

updateOptions(next): void

Defined in: packages/dom/src/workspace-api.ts:397

Parameters

next

WorkspaceOptionUpdates<State>

Returns

void

Implementation of

WorkspaceHandle.updateOptions

---

updatePane()

updatePane(pane): void

Defined in: packages/dom/src/workspace-api.ts:556

Parameters

pane

Pane

Returns

void

Implementation of

WorkspaceHandle.updatePane