Interface: IActivityBarService
services.IActivityBarService
Hierarchy
Component\<IActivityBar>↳
IActivityBarService
Table of contents
Properties
Methods
- add
- addContextMenu
- onChange
- onClick
- remove
- removeContextMenu
- reset
- setActive
- subscribe
- toggleBar
- toggleContextMenuChecked
- unsubscribe
Properties
state
• Protected Abstract state: IActivityBar
Inherited from
Component.state
Defined in
Methods
add
▸ add(data, isActive?): void
Add IActivityBarItem data
Parameters
| Name | Type | Description |
|---|---|---|
data | IActivityBarItem | IActivityBarItem[] | - |
isActive? | boolean | If provide, Activity Bar will set data active automatically. Only works in one data |
Returns
void
Defined in
src/services/workbench/activityBarService.ts:18
addContextMenu
▸ addContextMenu(data): void
Add new contextMenus for the activityBar
Parameters
| Name | Type |
|---|---|
data | IActivityMenuItemProps | IActivityMenuItemProps[] |
Returns
void
Defined in
src/services/workbench/activityBarService.ts:41
onChange
▸ onChange(callback): any
Called when activity bar item which is not global is changed
Parameters
| Name | Type |
|---|---|
callback | (prevSelectedKey?: UniqueId, nextSelectedKey?: UniqueId) => void |
Returns
any
Defined in
src/services/workbench/activityBarService.ts:55
onClick
▸ onClick(callback): any
Add click event listener
Parameters
| Name | Type |
|---|---|
callback | (selectedKey: UniqueId, item: IActivityBarItem) => void |
Returns
any
Defined in
src/services/workbench/activityBarService.ts:51
remove
▸ remove(id): void
Remove the specific activity bar by id
Parameters
| Name | Type |
|---|---|
id | UniqueId | UniqueId[] |
Returns
void
Defined in
src/services/workbench/activityBarService.ts:27
removeContextMenu
▸ removeContextMenu(id): void
Remove the specific contextMenu item by id
Parameters
| Name | Type | Description |
|---|---|---|
id | UniqueId | UniqueId[] | contextmenu id |
Returns
void
Defined in
src/services/workbench/activityBarService.ts:46
reset
▸ reset(): void
Reset the activityBar state data, if you want to whole customize the activityBar, you can reset it first, and then using the activityBar.add() method to fill the data you need.
Returns
void
Defined in
src/services/workbench/activityBarService.ts:13
setActive
▸ setActive(id?): void
Set active bar
Parameters
| Name | Type |
|---|---|
id? | UniqueId |
Returns
void
Defined in
src/services/workbench/activityBarService.ts:22
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
toggleBar
▸ toggleBar(id): void
Toggle the specific activity bar between show or hide
Parameters
| Name | Type | Description |
|---|---|---|
id | UniqueId | activity bar id |
Returns
void
Defined in
src/services/workbench/activityBarService.ts:32
toggleContextMenuChecked
▸ toggleContextMenuChecked(id): void
Toggle the contextMenu between checked or unchecked
Parameters
| Name | Type | Description |
|---|---|---|
id | UniqueId | contextmenu id |
Returns
void
Defined in
src/services/workbench/activityBarService.ts:37
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