quilt-react / Interface: WorkspaceHandle<State>

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

The mounted API. The model and its lifetime remain private to Quilt.

Type Parameters

State

State = unknown

Properties

isDisposed

readonly isDisposed: boolean

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

Methods

activatePane()

activatePane(id): void

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

Parameters

id

string

Returns

void

---

addPane()

addPane(type, options?): PaneHandle | undefined

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

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

Parameters

type

string

options?

AddPaneOptions

Returns

PaneHandle | undefined

---

can()

can(paneId, capability): boolean

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

Parameters

paneId

string

capability

Capability

Returns

boolean

---

canExecuteAction()

canExecuteAction(action, context?): boolean

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

Parameters

action

CommandId

context?

ActionContext

Returns

boolean

---

canNode()

canNode(nodeId, capability): boolean

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

Parameters

nodeId

string

capability

Capability

Returns

boolean

---

canRestoreClosedPane()

canRestoreClosedPane(): boolean

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

Returns

boolean

---

closeGroup()

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

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

Parameters

id

string

options?

CloseOptions

Returns

Promise<boolean>

---

closePane()

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

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

Confirm and check permissions unless force is explicitly supplied.

Parameters

id

string

options?

CloseOptions

Returns

Promise<boolean>

---

dedicateGroup()

dedicateGroup(id): Promise<boolean>

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

Parameters

id

string

Returns

Promise<boolean>

---

dispose()

dispose(): void

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

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

Returns

void

---

executeAction()

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

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

Parameters

action

CommandId

context?

ActionContext

Returns

Promise<boolean>

---

exportLayout()

exportLayout(): LayoutSnapshot

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

Mutable arrangement copy. Use exportWorkspace for persistence with appearance.

Returns

LayoutSnapshot

---

exportWorkspace()

exportWorkspace(): WorkspacePreset

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

Returns

WorkspacePreset

---

getAutoCollapse()

getAutoCollapse(): AutoCollapse

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

Returns

AutoCollapse

---

getCommands()

getCommands(): readonly RegisteredCommand[]

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

Immutable metadata for registered application commands.

Returns

readonly RegisteredCommand[]

---

getLayout()

getLayout(): LayoutSnapshot

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

Stable immutable arrangement snapshot, including live detached records.

Returns

LayoutSnapshot

---

getPane()

getPane(id): PaneHandle | undefined

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

Parameters

id

string

Returns

PaneHandle | undefined

---

getPanes()

getPanes(): PaneHandle[]

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

Returns

PaneHandle[]

---

getShortcutConflicts()

getShortcutConflicts(): readonly ShortcutConflict[]

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

All same-workspace collisions, including externally handled bindings.

Returns

readonly ShortcutConflict[]

---

getShortcuts()

getShortcuts(): readonly RegisteredShortcut[]

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

Returns

readonly RegisteredShortcut[]

---

insertPane()

insertPane(pane, groupId, options?): void

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

Parameters

pane

Pane

groupId

string

options?

CommandOptions

Returns

void

---

joinGroup()

joinGroup(groupId, options?): void

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

Parameters

groupId

string

options?

CommandOptions

Returns

void

---

joinGroups()

joinGroups(receiverId, otherId, options?): void

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

Parameters

receiverId

string

otherId

string

options?

JoinOptions

Returns

void

---

loadLayout()

loadLayout(input): void

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

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

Parameters

input

unknown

Returns

void

---

loadWorkspace()

loadWorkspace(input): void

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

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

Parameters

input

unknown

Returns

void

---

maximize()

maximize(groupId, options?): void

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

Parameters

groupId

string | null

options?

CommandOptions

Returns

void

---

movePane()

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

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

Parameters

paneId

string

groupId

string

position?

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

index?

number

options?

CommandOptions

Returns

void

---

on()

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

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

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

---

popout()

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

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

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

Parameters

id

string

placement?

WindowPlacement

Returns

Promise<boolean>

---

refreshTheme()

refreshTheme(): void

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

Returns

void

---

registerCommand()

registerCommand(command): () => void

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

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

Parameters

command

CommandRegistration

Returns

() => void

---

registerShortcut()

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

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

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

Parameters

action

CommandId

registration

ShortcutRegistration

Returns

() => void

---

releaseGroup()

releaseGroup(id): void

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

Parameters

id

string

Returns

void

---

removeEmptyGroup()

removeEmptyGroup(groupId): void

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

Parameters

groupId

string

Returns

void

---

reset()

reset(): void

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

Restore the initial arrangement and appearance.

Returns

void

---

resize()

resize(splitId, ratio, options?): void

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

Parameters

splitId

string

ratio

number

options?

CommandOptions

Returns

void

---

resizeMany()

resizeMany(ratios, options?): void

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

Parameters

ratios

Record<string, number>

options?

CommandOptions

Returns

void

---

restoreClosedPane()

restoreClosedPane(): void

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

Returns

void

---

retryPane()

retryPane(id): void

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

Parameters

id

string

Returns

void

---

returnPane()

returnPane(id): void

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

Parameters

id

string

Returns

void

---

setAutoCollapse()

setAutoCollapse(mode): void

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

Parameters

mode

AutoCollapse

Returns

void

---

setTabBar()

setTabBar(tabBar): void

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

Parameters

tabBar

TabBarOptions

Returns

void

---

setTabDisplay()

setTabDisplay(groupId, display): void

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

Parameters

groupId

string

display

"automatic" | "compact" | undefined

Returns

void

---

setTabPlacement()

setTabPlacement(groupId, placement): void

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

Parameters

groupId

string

placement

"top" | "left" | undefined

Returns

void

---

setTheme()

setTheme(theme): void

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

Parameters

theme

LayoutTheme

Returns

void

---

splitGroup()

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

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

Parameters

groupId

string

axis

Axis

pane?

Pane | null

options?

CommandOptions & object

Returns

string

---

updateOptions()

updateOptions(options): void

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

Parameters

options

WorkspaceOptionUpdates<State>

Returns

void

---

updatePane()

updatePane(pane): void

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

Parameters

pane

Pane

Returns

void