quilt-react / Interface: WorkspaceSettings<State>

Defined in: packages/dom/src/types.ts:66

Live appearance, interactions, and application integration callbacks.

Type Parameters

State

State = unknown

Properties

capabilities?

optional capabilities?: CapabilityPolicy

Defined in: packages/dom/src/types.ts:68

Session interaction policy, with workspace defaults and region/tab overrides.

---

commands?

optional commands?: readonly CommandRegistration[]

Defined in: packages/dom/src/types.ts:92

---

confirmClose?

optional confirmClose?: (request) => boolean | Promise<boolean>

Defined in: packages/dom/src/types.ts:83

Parameters

request

CloseRequest

Returns

boolean | Promise<boolean>

---

contextMenu?

optional contextMenu?: "button" | "none" | "right-click" | "both"

Defined in: packages/dom/src/types.ts:74

Global pane-menu entry points. Defaults to both; not serialized in Layout JSON.

---

contextMenuIcon?

optional contextMenuIcon?: "three-dots" | "one-dot"

Defined in: packages/dom/src/types.ts:76

Global integrated menu button appearance. Defaults to three-dots; session-only.

---

formatShortcut?

optional formatShortcut?: (binding) => string

Defined in: packages/dom/src/types.ts:98

Customize presentation only; matching and accessibility encoding use the binding.

Parameters

binding

Readonly<KeyBinding>

Returns

string

---

getPaneState?

optional getPaneState?: (paneId) => State

Defined in: packages/dom/src/types.ts:99

Parameters

paneId

string

Returns

State

---

messages?

optional messages?: Partial<Record<"Unpin tab" | "Pin active tab" | "Tabs in {id}" | "{count} empty region" | "{count} empty regions" | "These regions cannot be joined" | "{target} absorbs {source}" | "{names} and {count} more" | "{target} absorbs {count} regions" | "Merge {count} regions" | "Joins {target}" | "{target} keeps all tabs" | "Pane could not be rendered." | "Pane workspace" | "Pane region" | "Resize panes" | "Close empty pane" | "Empty pane actions" | "Choose a tab" | "+ Add tab" | "Split" | "Split left" | "Split right" | "Split up" | "Split down" | "Join sibling region" | "This region" | "Restore region" | "Maximize region" | "Open in window" | "Tab orientation" | "Workspace default" | "Horizontal" | "Vertical" | "Tab display" | "Automatic" | "Compact" | "Close active tab" | "Close pane" | "Restore closed tab" | "Cancel" | "Search tabs…" | "Search tabs" | "Available tabs" | "No matching tabs" | "Return to layout" | "Disconnected: the main layout session has ended." | "The browser blocked the popout. Allow popups or try again from the pane menu." | "Close selected panes?" | "Close" | "New pane" | "Empty region" | "Click to add a tab" | "Drag inward to split; drag across adjacent regions to join. Escape cancels." | "{title} actions" | "Close {title}" | "{count} tab types" | "Unknown pane type: {type}. Register a renderer to display this pane." | "Could not mount {title}. Retry this pane." | "Split or join region from {corner} corner", string>>

Defined in: packages/dom/src/types.ts:81

---

onError?

optional onError?: (error) => void

Defined in: packages/dom/src/types.ts:100

Parameters

error

unknown

Returns

void

---

onShortcutConflict?

optional onShortcutConflict?: (conflicts) => void

Defined in: packages/dom/src/types.ts:96

Receives diagnostics in warn mode; otherwise warnings use console.warn.

Parameters

conflicts

readonly ShortcutConflict[]

Returns

void

---

openWindow?

optional openWindow?: (pane, placement) => Window | null

Defined in: packages/dom/src/types.ts:104

Override window creation for applications with a managed same-origin host. Must return synchronously.

Parameters

pane

Pane

placement

WindowPlacement

Returns

Window | null

---

popouts?

optional popouts?: boolean

Defined in: packages/dom/src/types.ts:82

---

prepareWindow?

optional prepareWindow?: (window, pane) => void

Defined in: packages/dom/src/types.ts:102

Copy additional app styles/assets into a same-origin companion document.

Parameters

window

Window

pane

Pane

Returns

void

---

renderIcon?

optional renderIcon?: (key, document) => Element | undefined

Defined in: packages/dom/src/types.ts:85

Return a fresh decorative icon element. Unknown keys use a title initial.

Parameters

key

string

document

Document

Returns

Element | undefined

---

resizeMode?

optional resizeMode?: "gutter" | "border"

Defined in: packages/dom/src/types.ts:70

Gutter reserves space; border overlays a resize target on one shared line.

---

resizeSnapping?

optional resizeSnapping?: boolean

Defined in: packages/dom/src/types.ts:72

Align pointer resizing to neighboring dividers within 8 CSS pixels. Defaults to true.

---

scrollbars?

optional scrollbars?: ScrollbarOptions

Defined in: packages/dom/src/types.ts:80

New workspaces default to auto-hide, overlay, scroll intent, and 500 ms idle delay. Explicit undefined selects native controls.

---

shortcutConflictPolicy?

optional shortcutConflictPolicy?: ShortcutConflictPolicy

Defined in: packages/dom/src/types.ts:94

Defaults to priority; error rejects conflicting changes atomically.

---

shortcuts?

optional shortcuts?: boolean | Partial<Record<CommandId, ShortcutRegistration>> & object

Defined in: packages/dom/src/types.ts:87

Opt-in conveniences; omitted and false disable all.

---

tabBar?

optional tabBar?: TabBarOptions

Defined in: packages/dom/src/types.ts:77

---

theme?

optional theme?: LayoutTheme

Defined in: packages/dom/src/types.ts:78