Namespace: Events
January 18, 2022 · View on GitHub
Kui API Documentation - v11.0.0 / @kui-shell/core / Events
Namespace: Events
@kui-shell/core.Events
Table of contents
Interfaces
Type aliases
Variables
Functions
Type aliases
SnapshotRequestEvent
Ƭ SnapshotRequestEvent: Object
Type declaration
| Name | Type | Description |
|---|---|---|
execUUID? | string | Capture just one block? |
cb? | (snapshot: Buffer) => void | - |
Defined in
packages/core/src/core/events.ts:39
StatusStripeChangeEvent
Ƭ StatusStripeChangeEvent: Object
Type declaration
| Name | Type |
|---|---|
message? | string |
type | "default" | "blue" | "yellow" | "red" |
Defined in
packages/core/src/core/events.ts:34
TabLayoutChangeEvent
Ƭ TabLayoutChangeEvent: Object
Type declaration
| Name | Type |
|---|---|
isSidecarNowHidden | boolean |
isWidthConstrained? | boolean |
Defined in
packages/core/src/core/events.ts:46
Variables
eventBus
• eventBus: EventBus
Defined in
packages/core/src/core/events.ts:406
eventChannelUnsafe
• eventChannelUnsafe: EventEmitter
Defined in
packages/core/src/core/events.ts:29
Functions
unwireToStandardEvents
▸ unwireToStandardEvents(listener): void
Unhook
Parameters
| Name | Type |
|---|---|
listener | (tab?: number | Tab) => void |
Returns
void
Defined in
packages/core/src/core/events.ts:443
unwireToTabEvents
▸ unwireToTabEvents(listener): void
Unhook
Parameters
| Name | Type |
|---|---|
listener | (tab?: number | Tab) => void |
Returns
void
Defined in
packages/core/src/core/events.ts:422
wireToStandardEvents
▸ wireToStandardEvents(listener): void
Hook an event listener up to the family of standard user interaction events.
Parameters
| Name | Type |
|---|---|
listener | (tab?: number | Tab) => void |
Returns
void
Defined in
packages/core/src/core/events.ts:433
wireToTabEvents
▸ wireToTabEvents(listener): void
Hook an event listener up to tab events.
Parameters
| Name | Type |
|---|---|
listener | (tab?: number | Tab) => void |
Returns
void