Interface: IAuxiliaryBarService
services.IAuxiliaryBarService
Hierarchy
Component\<IAuxiliaryBar>↳
IAuxiliaryBarService
Table of contents
Properties
Methods
Properties
onTabClick
• onTabClick: (callback: (key: UniqueId) => void) => void
Type declaration
▸ (callback): void
Called when auxiliary tab title clicked
Parameters
| Name | Type |
|---|---|
callback | (key: UniqueId) => void |
Returns
void
Defined in
src/services/workbench/auxiliaryBarService.ts:36
reset
• reset: () => void
Type declaration
▸ (): void
Reset all states
Returns
void
Defined in
src/services/workbench/auxiliaryBarService.ts:40
setChildren
• setChildren: (children: ReactNode) => void
Type declaration
▸ (children): void
Set the children of auxiliary bar
Parameters
| Name | Type |
|---|---|
children | ReactNode |
Returns
void
Defined in
src/services/workbench/auxiliaryBarService.ts:32
setMode
• setMode: (mode: IAuxiliaryBarMode | (preState: IAuxiliaryBarMode) => IAuxiliaryBarMode) => IAuxiliaryBarMode
Type declaration
▸ (mode): IAuxiliaryBarMode
Set the mode of auxiliary bar
Parameters
| Name | Type |
|---|---|
mode | IAuxiliaryBarMode | (preState: IAuxiliaryBarMode) => IAuxiliaryBarMode |
Returns
Defined in
src/services/workbench/auxiliaryBarService.ts:24
state
• Protected Abstract state: IAuxiliaryBar
Inherited from
Component.state
Defined in
Methods
addAuxiliaryBar
▸ addAuxiliaryBar(tabs): void
Parameters
| Name | Type |
|---|---|
tabs | IAuxiliaryData | IAuxiliaryData[] |
Returns
void
Defined in
src/services/workbench/auxiliaryBarService.ts:16
getCurrentTab
▸ getCurrentTab(): undefined | IAuxiliaryData
Get the current tab
Returns
undefined | IAuxiliaryData
Defined in
src/services/workbench/auxiliaryBarService.ts:15
setActive
▸ setActive(current): void
Set the active one on data
Parameters
| Name | Type |
|---|---|
current | undefined | UniqueId |
Returns
void
Defined in
src/services/workbench/auxiliaryBarService.ts:20
subscribe
▸ subscribe(name, listener): void
Subscribe the service event
Parameters
| Name | Type | Description |
|---|---|---|
name | string | string[] | Event name |
listener | Function | Listener function |
Returns
void
Inherited from
Component.subscribe
Defined in
src/common/event/eventBus.ts:11
unsubscribe
▸ unsubscribe(name, listener?): void
Unsubscribe the specific event and the listener function
Parameters
| Name | Type | Description |
|---|---|---|
name | any | The event name |
listener? | Function | optional, it unsubscribes events via name if not pass the listener function |
Returns
void
Inherited from
Component.unsubscribe