Globals / "src/renderer/components/dock/dock.store" / DockStore
Class: DockStore#
Hierarchy#
- DockStore
Index#
Constructors#
Properties#
Accessors#
Methods#
- checkMaxHeight
- close
- closeTab
- createTab
- getNewTabNumber
- getTabById
- hasTabs
- onResize
- onTabChange
- open
- reset
- selectTab
- setHeight
- toggle
- toggleFillSize
Constructors#
constructor#
+ new DockStore(): DockStore
Defined in src/renderer/components/dock/dock.store.ts:55
Returns: DockStore
Properties#
defaultTabId#
• Readonly defaultTabId: string = this.initialTabs[0].id
Defined in src/renderer/components/dock/dock.store.ts:31
fullSize#
• fullSize: boolean = false
Defined in src/renderer/components/dock/dock.store.ts:35
height#
• height: number = this.defaultHeight
Defined in src/renderer/components/dock/dock.store.ts:36
initialTabs#
• Protected initialTabs: IDockTab[] = [ { id: "terminal", kind: TabKind.TERMINAL, title: "Terminal" }, ]
Defined in src/renderer/components/dock/dock.store.ts:26
isOpen#
• isOpen: boolean = false
Defined in src/renderer/components/dock/dock.store.ts:34
minHeight#
• Readonly minHeight: 100 = 100
Defined in src/renderer/components/dock/dock.store.ts:32
selectedTabId#
• selectedTabId: string = this.defaultTabId
Defined in src/renderer/components/dock/dock.store.ts:38
storage#
• Protected storage: StorageHelper\<{}> = createStorage("dock", {})
Defined in src/renderer/components/dock/dock.store.ts:30
tabs#
• tabs: IObservableArray\<IDockTab> = observable.array\
Defined in src/renderer/components/dock/dock.store.ts:37
Accessors#
defaultHeight#
• get defaultHeight(): number
Defined in src/renderer/components/dock/dock.store.ts:44
Returns: number
maxHeight#
• get maxHeight(): number
Defined in src/renderer/components/dock/dock.store.ts:48
Returns: number
selectedTab#
• get selectedTab(): IDockTab
Defined in src/renderer/components/dock/dock.store.ts:40
Returns: IDockTab
Methods#
checkMaxHeight#
▸ ProtectedcheckMaxHeight(): void
Defined in src/renderer/components/dock/dock.store.ts:73
Returns: void
close#
▸ close(): void
Defined in src/renderer/components/dock/dock.store.ts:103
Returns: void
closeTab#
▸ closeTab(tabId: TabId): Promise\
Defined in src/renderer/components/dock/dock.store.ts:150
Parameters:
| Name | Type |
|---|---|
tabId |
TabId |
Returns: Promise\
createTab#
▸ createTab(anonTab: IDockTab, addNumber?: boolean): IDockTab
Defined in src/renderer/components/dock/dock.store.ts:136
Parameters:
| Name | Type | Default value |
|---|---|---|
anonTab |
IDockTab | - |
addNumber |
boolean | true |
Returns: IDockTab
getNewTabNumber#
▸ ProtectedgetNewTabNumber(kind: TabKind): number
Defined in src/renderer/components/dock/dock.store.ts:123
Parameters:
| Name | Type |
|---|---|
kind |
TabKind |
Returns: number
getTabById#
▸ getTabById(tabId: TabId): IDockTab
Defined in src/renderer/components/dock/dock.store.ts:119
Parameters:
| Name | Type |
|---|---|
tabId |
TabId |
Returns: IDockTab
hasTabs#
▸ hasTabs(): boolean
Defined in src/renderer/components/dock/dock.store.ts:90
Returns: boolean
onResize#
▸ onResize(callback: () => void, options?: IReactionOptions): IReactionDisposer
Defined in src/renderer/components/dock/dock.store.ts:82
Parameters:
| Name | Type |
|---|---|
callback |
() => void |
options? |
IReactionOptions |
Returns: IReactionDisposer
onTabChange#
▸ onTabChange(callback: (tabId: TabId) => void, options?: IReactionOptions): IReactionDisposer
Defined in src/renderer/components/dock/dock.store.ts:86
Parameters:
| Name | Type |
|---|---|
callback |
(tabId: TabId) => void |
options? |
IReactionOptions |
Returns: IReactionDisposer
open#
▸ open(fullSize?: boolean): void
Defined in src/renderer/components/dock/dock.store.ts:95
Parameters:
| Name | Type |
|---|---|
fullSize? |
boolean |
Returns: void
reset#
▸ reset(): void
Defined in src/renderer/components/dock/dock.store.ts:184
Returns: void
selectTab#
▸ selectTab(tabId: TabId): void
Defined in src/renderer/components/dock/dock.store.ts:174
Parameters:
| Name | Type |
|---|---|
tabId |
TabId |
Returns: void
setHeight#
▸ setHeight(height?: number): void
Defined in src/renderer/components/dock/dock.store.ts:179
Parameters:
| Name | Type |
|---|---|
height? |
number |
Returns: void
toggle#
▸ toggle(): void
Defined in src/renderer/components/dock/dock.store.ts:108
Returns: void
toggleFillSize#
▸ toggleFillSize(): void
Defined in src/renderer/components/dock/dock.store.ts:114
Returns: void