Module: @kui-shell/plugin-client-common
January 18, 2022 · View on GitHub
Kui API Documentation - v11.0.0 / @kui-shell/plugin-client-common
Module: @kui-shell/plugin-client-common
Table of contents
Classes
- ContextWidgets
- CurrentWorkingDirectory
- FancyPipeline
- HTMLDom
- InputProvider
- Kui
- MadeWithKui
- MeterWidgets
- Settings
- StatusStripe
- TabContainer
- TabContent
- TabModel
- TextWithIconWidget
Interfaces
Type aliases
Properties
Variables
- Alert
- Ansi
- Button
- Card
- DropDown
- Icons
- LeftNavSidecar
- Markdown
- Popover
- Select
- Tag
- TagWidget
- TopNavSidecar
Functions
- DropdownWidget
- Loading
- SpaceFiller
- Tooltip
- allocateTabUUID
- defaultOnKeyDown
- defaultOnKeyPress
- defaultOnKeyUp
- inDebugMode
Type aliases
InputProviderProps
Ƭ InputProviderProps: InputOptions & InputProps & BlockViewTraits
Defined in
plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:160
KuiProps
Ƭ KuiProps: Partial<KuiConfiguration> & GuidebookProps & CommonClientProps & { bottomInput?: true | React.ReactNode ; initialTabTitle?: string ; noBootstrap?: boolean ; quietExecCommand?: boolean ; toplevel?: React.ReactNode | React.ReactNode[] }
Defined in
plugins/plugin-client-common/src/components/Client/Kui.tsx:44
SplitPosition
Ƭ SplitPosition: NewSplitRequest["options"]["position"]
Defined in
plugins/plugin-client-common/src/components/Views/Terminal/SplitPosition.ts:19
ViewLevel
Ƭ ViewLevel: "loading" | "removed" | "hidden" | "normal" | "obscured" | "ok" | "warn" | "error" | "info"
variants of how the information should be presented
Defined in
plugins/plugin-client-common/src/components/Client/StatusStripe/TextWithIconWidget.tsx:24
Properties
KuiContext
• KuiContext: Context<KuiConfiguration>
Variables
Alert
• Alert: LazyExoticComponent<(props: Props) => React.ReactElement>
Defined in
plugins/plugin-client-common/src/index.ts:65
Ansi
• Ansi: LazyExoticComponent<(props: Props) => Element>
Defined in
plugins/plugin-client-common/src/index.ts:55
Button
• Button: LazyExoticComponent<(props: Props) => React.ReactElement>
Defined in
plugins/plugin-client-common/src/index.ts:66
Card
• Card: LazyExoticComponent<(props: Props) => React.ReactElement>
Defined in
plugins/plugin-client-common/src/index.ts:67
DropDown
• DropDown: LazyExoticComponent<(props: Props) => React.ReactElement>
Defined in
plugins/plugin-client-common/src/index.ts:72
Icons
• Icons: LazyExoticComponent<(props: Props) => React.ReactElement>
Defined in
plugins/plugin-client-common/src/index.ts:71
LeftNavSidecar
• LeftNavSidecar: LazyExoticComponent<typeof default>
Defined in
plugins/plugin-client-common/src/index.ts:62
Markdown
• Markdown: LazyExoticComponent<typeof default>
Defined in
plugins/plugin-client-common/src/index.ts:57
Popover
• Popover: LazyExoticComponent<(props: Props) => React.ReactElement>
Defined in
plugins/plugin-client-common/src/index.ts:68
Select
• Select: LazyExoticComponent<(props: Props) => React.ReactElement>
Defined in
plugins/plugin-client-common/src/index.ts:69
Tag
• Tag: LazyExoticComponent<(props: Props) => React.ReactElement>
Defined in
plugins/plugin-client-common/src/index.ts:70
TagWidget
• TagWidget: LazyExoticComponent<(props: Props) => Element>
Defined in
plugins/plugin-client-common/src/index.ts:50
TopNavSidecar
• TopNavSidecar: LazyExoticComponent<typeof default>
Defined in
plugins/plugin-client-common/src/index.ts:61
Functions
DropdownWidget
▸ DropdownWidget(props): Element
Parameters
| Name | Type |
|---|---|
props | Props |
Returns
Element
Defined in
plugins/plugin-client-common/src/components/Client/StatusStripe/DropdownWidget.tsx:33
Loading
▸ Loading(props): React.ReactElement
Parameters
| Name | Type |
|---|---|
props | default |
Returns
React.ReactElement
Defined in
plugins/plugin-client-common/src/components/spi/Loading/index.tsx:22
SpaceFiller
▸ SpaceFiller(): Element
This components can be used as a space filler in your StatusStripe.
Returns
Element
Defined in
plugins/plugin-client-common/src/components/Client/StatusStripe/SpaceFiller.tsx:23
Tooltip
▸ Tooltip(props): React.ReactElement
Parameters
| Name | Type |
|---|---|
props | Props |
Returns
React.ReactElement
Defined in
plugins/plugin-client-common/src/components/spi/Tooltip/index.tsx:24
allocateTabUUID
▸ allocateTabUUID(): string
Returns
string
Defined in
plugins/plugin-client-common/src/components/Client/TabModel.ts:21
defaultOnKeyDown
▸ defaultOnKeyDown(event): void
Parameters
| Name | Type |
|---|---|
event | KeyboardEvent |
Returns
void
Defined in
plugins/plugin-client-common/src/components/Views/Terminal/Block/OnKeyDown.ts:98
defaultOnKeyPress
▸ defaultOnKeyPress(event): Promise<void>
Parameters
| Name | Type |
|---|---|
event | KeyboardEvent |
Returns
Promise<void>
Defined in
plugins/plugin-client-common/src/components/Views/Terminal/Block/OnKeyPress.ts:21
defaultOnKeyUp
▸ defaultOnKeyUp(evt): Promise<void>
Listen for ctrl+R
Parameters
| Name | Type |
|---|---|
evt | KeyboardEvent<Element> |
Returns
Promise<void>
Defined in
plugins/plugin-client-common/src/components/Views/Terminal/Block/ActiveISearch.tsx:182
inDebugMode
▸ inDebugMode(): string | true
Returns
string | true