Kui API Documentation - v11.0.0 / @kui-shell/plugin-client-common / InputProviderState

Interface: InputProviderState

@kui-shell/plugin-client-common.InputProviderState

Table of contents

Properties

• execUUID
• isReEdit
• isearch
• model
• multiline
• pasteMultiLineTexts
• prompt
• tabCompletion
• typeahead

Properties

execUUID

• Optional execUUID: string

the execution ID for this prompt, if any

Defined in

plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:176

---

isReEdit

• Optional isReEdit: boolean

did user click to re-edit the input?

Defined in

plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:173

---

isearch

• Optional isearch: default

state of active reverse-i-search

Defined in

plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:182

---

model

• model: BlockModel

Copy from props; to help with getDerivedStateFromProps

Defined in

plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:164

---

multiline

• Optional multiline: boolean

is the input in multi-line mode? if true, use text area rather than in-line input

Defined in

plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:167

---

pasteMultiLineTexts

• Optional pasteMultiLineTexts: string

did user paste multiline texts

Defined in

plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:170

---

prompt

• Optional prompt: InputElement

DOM element for prompt; set via ref in render() below

Defined in

plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:179

---

tabCompletion

• Optional tabCompletion: TabCompletionState

state of tab completion

Defined in

plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:185

---

typeahead

• Optional typeahead: string

typeahead completion?

Defined in

plugins/plugin-client-common/src/components/Views/Terminal/Block/Input.tsx:188