quilt-core / Class: LayoutStore

Defined in: packages/core/src/controller.ts:30

Constructors

Constructor

new LayoutStore(input, options?): LayoutStore

Defined in: packages/core/src/controller.ts:43

Parameters

input

unknown

options?

LayoutStoreOptions = {}

Returns

LayoutStore

Methods

activate()

activate(groupId, paneId): void

Defined in: packages/core/src/controller.ts:345

Parameters

groupId

string

paneId

string

Returns

void

---

add()

add(pane, groupId, options?): void

Defined in: packages/core/src/controller.ts:377

Parameters

pane

Pane

groupId

string

options?

CommandOptions = {}

Returns

void

---

can()

can(paneId, capability): boolean

Defined in: packages/core/src/controller.ts:279

Parameters

paneId

string

capability

Capability

Returns

boolean

---

canNode()

canNode(nodeId, capability): boolean

Defined in: packages/core/src/controller.ts:295

Test every affected tab, including policy on empty regions.

Parameters

nodeId

string

capability

Capability

Returns

boolean

---

canRestoreClosedTab()

canRestoreClosedTab(): boolean

Defined in: packages/core/src/controller.ts:599

Returns

boolean

---

close()

close(paneId, options?): void

Defined in: packages/core/src/controller.ts:587

Parameters

paneId

string

options?

CommandOptions = {}

Returns

void

---

closeGroup()

closeGroup(groupId, options?): void

Defined in: packages/core/src/controller.ts:504

Close all docked tabs and remove their region in one atomic command.

Parameters

groupId

string

options?

CommandOptions = {}

Returns

void

---

dedicateGroup()

dedicateGroup(groupId, options?): void

Defined in: packages/core/src/controller.ts:313

Parameters

groupId

string

options?

CommandOptions = {}

Returns

void

---

dispose()

dispose(): void

Defined in: packages/core/src/controller.ts:669

Returns

void

---

export()

export(): Layout

Defined in: packages/core/src/controller.ts:52

Returns

Layout

---

getAutoCollapse()

getAutoCollapse(): AutoCollapse

Defined in: packages/core/src/controller.ts:198

Returns

AutoCollapse

---

getResizeSnapping()

getResizeSnapping(): boolean

Defined in: packages/core/src/controller.ts:166

Returns

boolean

---

getSnapshot()

getSnapshot(): Layout

Defined in: packages/core/src/controller.ts:51

Stable immutable snapshot, suitable for useSyncExternalStore.

Returns

Layout

---

join()

join(groupId, options?): void

Defined in: packages/core/src/controller.ts:490

Join the sibling region at this split, retaining its content as tabs.

Parameters

groupId

string

options?

CommandOptions = {}

Returns

void

---

joinRegions()

joinRegions(receiverId, otherId, options?): void

Defined in: packages/core/src/controller.ts:519

Join a contiguous row/column range into the receiver, including both endpoints.

Parameters

receiverId

string

otherId

string

options?

JoinOptions = {}

Returns

void

---

load()

load(input): void

Defined in: packages/core/src/controller.ts:303

Parameters

input

unknown

Returns

void

---

maximize()

maximize(groupId, options?): void

Defined in: packages/core/src/controller.ts:371

Parameters

groupId

string | null

options?

CommandOptions = {}

Returns

void

---

move()

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

Defined in: packages/core/src/controller.ts:451

Move to a tab group or to a new split at an edge.

Parameters

paneId

string

groupId

string

position?

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

index?

number

options?

CommandOptions = {}

Returns

void

---

onError()

onError(listener): () => void

Defined in: packages/core/src/controller.ts:62

Parameters

listener

(error) => void

Returns

() => void

---

popout()

popout(paneId, placement?, options?): void

Defined in: packages/core/src/controller.ts:645

Parameters

paneId

string

placement?

WindowPlacement

options?

CommandOptions = {}

Returns

void

---

releaseGroup()

releaseGroup(groupId): void

Defined in: packages/core/src/controller.ts:324

Parameters

groupId

string

Returns

void

---

removeEmptyGroup()

removeEmptyGroup(groupId, options?): void

Defined in: packages/core/src/controller.ts:435

Cancel only an unfilled region; never roll back edits made elsewhere.

Parameters

groupId

string

options?

CommandOptions = {}

Returns

void

---

reset()

reset(): void

Defined in: packages/core/src/controller.ts:310

Returns

void

---

resize()

resize(splitId, ratio, options?): void

Defined in: packages/core/src/controller.ts:352

Parameters

splitId

string

ratio

number

options?

CommandOptions = {}

Returns

void

---

resizeMany()

resizeMany(ratios, options?): void

Defined in: packages/core/src/controller.ts:361

Atomically update coupled split ratios without intermediate layouts.

Parameters

ratios

Record<string, number>

options?

CommandOptions = {}

Returns

void

---

restoreClosedTab()

restoreClosedTab(): void

Defined in: packages/core/src/controller.ts:603

Restore the latest closed tab without undoing unrelated layout changes.

Returns

void

---

returnPane()

returnPane(paneId): void

Defined in: packages/core/src/controller.ts:661

Parameters

paneId

string

Returns

void

---

setAutoCollapse()

setAutoCollapse(mode): void

Defined in: packages/core/src/controller.ts:201

Parameters

mode

AutoCollapse

Returns

void

---

setCapabilities()

setCapabilities(policy?): void

Defined in: packages/core/src/controller.ts:228

Replace session policy; layout export/load never serializes or resets it.

Parameters

policy?

CapabilityPolicy = {}

Returns

void

---

setResizeSnapping()

setResizeSnapping(enabled): void

Defined in: packages/core/src/controller.ts:169

Parameters

enabled

boolean

Returns

void

---

setTabDisplay()

setTabDisplay(groupId, display): void

Defined in: packages/core/src/controller.ts:329

Parameters

groupId

string

display

"automatic" | "compact" | undefined

Returns

void

---

setTabPlacement()

setTabPlacement(groupId, placement): void

Defined in: packages/core/src/controller.ts:337

Parameters

groupId

string

placement

"top" | "left" | undefined

Returns

void

---

snapResize()

snapResize(position, edges, threshold?): number

Defined in: packages/core/src/controller.ts:177

Resolve an interactive resize coordinate against edges in the same coordinate space. Direct resize commands remain exact. The renderer supplies measured edge coordinates.

Parameters

position

number

edges

readonly number[]

threshold?

number = 8

Returns

number

---

split()

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

Defined in: packages/core/src/controller.ts:398

Parameters

groupId

string

axis

Axis

pane

Pane | null

options?

CommandOptions & object = {}

Returns

string

---

subscribe()

subscribe(listener): () => void

Defined in: packages/core/src/controller.ts:55

Parameters

listener

(event) => void

Returns

() => void

---

updatePane()

updatePane(pane): void

Defined in: packages/core/src/controller.ts:392

Parameters

pane

Pane

Returns

void