WorkspaceSidedock

Class: WorkspaceSidedock

Defined in: workspace.svelte.ts:362

Collapsible split container used for the left and right workspace sidebars.

Extends

• WorkspaceSplit<{ sidebar-changed: [string, boolean, string]; }>

Constructors

Constructor

new WorkspaceSidedock(options?): WorkspaceSidedock

Defined in: workspace.svelte.ts:368

Parameters

options?

Partial<SidebarStateProps> = {}

Returns

WorkspaceSidedock

Overrides

WorkspaceSplit.constructor

Properties

_root

_root: WorkspaceItem<EventMap<T>> | undefined = undefined

Defined in: workspace.svelte.ts:102

Inherited from

WorkspaceSplit._root

---

children

children: (WorkspaceTabs | WorkspaceView)[]

Defined in: workspace.svelte.ts:203

Inherited from

WorkspaceSplit.children

---

id

id: string

Defined in: workspace.svelte.ts:96

Inherited from

WorkspaceSplit.id

---

parent

parent: WorkspaceParent

Defined in: workspace.svelte.ts:94

Inherited from

WorkspaceSplit.parent

---

sidebar

sidebar: SidebarState

Defined in: workspace.svelte.ts:366

---

sizes

sizes: number[]

Defined in: workspace.svelte.ts:204

Inherited from

WorkspaceSplit.sizes

---

type

type: "horizontal" | "vertical"

Defined in: workspace.svelte.ts:202

Inherited from

WorkspaceSplit.type

Accessors

collapsed

Get Signature

get collapsed(): boolean

Defined in: workspace.svelte.ts:413

Returns

boolean

---

size

Get Signature

get size(): string

Defined in: workspace.svelte.ts:409

Returns

string

---

topLeft

Get Signature

get topLeft(): void | WorkspaceTabs

Defined in: workspace.svelte.ts:334

Returns

void | WorkspaceTabs

Inherited from

WorkspaceSplit.topLeft

---

topRight

Get Signature

get topRight(): WorkspaceTabs

Defined in: workspace.svelte.ts:338

Returns

WorkspaceTabs

Inherited from

WorkspaceSplit.topRight

Methods

addChild()

addChild(child, index?): void

Defined in: workspace.svelte.ts:244

Parameters

child

WorkspaceTabs | WorkspaceView

index?

number

Returns

void

Inherited from

WorkspaceSplit.addChild

---

collapse()

collapse(): void

Defined in: workspace.svelte.ts:421

Returns

void

---

dispatch()

dispatch<T>(eventName, …args): boolean

Defined in: events.ts:105

Type Parameters

T

T extends "sidebar-changed"

Parameters

eventName

T

args

…ArgumentMap<{ sidebar-changed: [string, boolean, string]; }>[Extract<T, "sidebar-changed">]

Returns

boolean

Inherited from

WorkspaceSplit.dispatch

---

emit()

emit<T>(eventName, …args): boolean

Defined in: events.ts:98

Type Parameters

T

T extends "sidebar-changed"

Parameters

eventName

T

args

…ArgumentMap<{ sidebar-changed: [string, boolean, string]; }>[Extract<T, "sidebar-changed">]

Returns

boolean

Inherited from

WorkspaceSplit.emit

---

expand()

expand(): void

Defined in: workspace.svelte.ts:425

Returns

void

---

getRoot()

getRoot(): WorkspaceItem

Defined in: workspace.svelte.ts:103

Returns

WorkspaceItem

Inherited from

WorkspaceSplit.getRoot

---

iterateAllLeaves()

iterateAllLeaves<T>(callback): void | T

Defined in: workspace.svelte.ts:292

Type Parameters

T

T = any

Parameters

callback

(leaf) => T

Returns

void | T

Inherited from

WorkspaceSplit.iterateAllLeaves

---

iterateAllSplits()

iterateAllSplits<T>(callback): void | T

Defined in: workspace.svelte.ts:259

Type Parameters

T

T = any

Parameters

callback

(split) => T

Returns

void | T

Inherited from

WorkspaceSplit.iterateAllSplits

---

iterateAllTabs()

iterateAllTabs<T>(callback): void | T

Defined in: workspace.svelte.ts:276

Type Parameters

T

T = any

Parameters

callback

(tab) => T

Returns

void | T

Inherited from

WorkspaceSplit.iterateAllTabs

---

loadJson()

loadJson(layout): Promise<void>

Defined in: workspace.svelte.ts:389

Parameters

layout

WorkspaceSidedockJson

Returns

Promise<void>

Overrides

WorkspaceSplit.loadJson

---

off()

off<T>(eventName, listener, context?, once?): void

Defined in: events.ts:78

Type Parameters

T

T extends "sidebar-changed"

Parameters

eventName

T

listener

(…args) => void

context?

any

once?

boolean

Returns

void

Inherited from

WorkspaceSplit.off

---

offref()

offref<T>(ref): void

Defined in: events.ts:87

Type Parameters

T

T extends "sidebar-changed"

Parameters

ref

EventRef<{ sidebar-changed: [string, boolean, string]; }, T>

Returns

void

Inherited from

WorkspaceSplit.offref

---

on()

on<T>(eventName, listener, context?): EventRef<{ sidebar-changed: [string, boolean, string]; }, T, any>

Defined in: events.ts:48

Type Parameters

T

T extends "sidebar-changed"

Parameters

eventName

T

listener

(…args) => void

context?

any

Returns

EventRef<{ sidebar-changed: [string, boolean, string]; }, T, any>

Inherited from

WorkspaceSplit.on

---

once()

once<T>(eventName, listener, context?): EventRef<{ sidebar-changed: [string, boolean, string]; }, T, any>

Defined in: events.ts:63

Type Parameters

T

T extends "sidebar-changed"

Parameters

eventName

T

listener

(…args) => void

context?

any

Returns

EventRef<{ sidebar-changed: [string, boolean, string]; }, T, any>

Inherited from

WorkspaceSplit.once

---

onEmpty()

onEmpty(): void

Defined in: workspace.svelte.ts:407

Returns

void

Overrides

WorkspaceSplit.onEmpty

---

removeChild()

removeChild(index, softDelete?): WorkspaceTabs | WorkspaceView | undefined

Defined in: workspace.svelte.ts:305

Parameters

index

number | WorkspaceTabs | WorkspaceSplit<EventMap<T>>

softDelete?

boolean = false

Returns

WorkspaceTabs | WorkspaceView | undefined

Inherited from

WorkspaceSplit.removeChild

---

toggle()

toggle(): void

Defined in: workspace.svelte.ts:417

Returns

void

---

toJson()

toJson(): WorkspaceSidedockJson

Defined in: workspace.svelte.ts:400

Returns

WorkspaceSidedockJson

Overrides

WorkspaceSplit.toJson

---

trigger()

trigger<T>(eventName, …args): boolean

Defined in: events.ts:91

Type Parameters

T

T extends "sidebar-changed"

Parameters

eventName

T

args

…ArgumentMap<{ sidebar-changed: [string, boolean, string]; }>[Extract<T, "sidebar-changed">]

Returns

boolean

Inherited from

WorkspaceSplit.trigger

---

tryTrigger()

tryTrigger<T>(evt, …args): void

Defined in: events.ts:112

Type Parameters

T

T extends "sidebar-changed"

Parameters

evt

EventRef<{ sidebar-changed: [string, boolean, string]; }, T>

args

…ArgumentMap<{ sidebar-changed: [string, boolean, string]; }>[Extract<T, "sidebar-changed">]

Returns

void

Inherited from

WorkspaceSplit.tryTrigger