kotlin-vscode/vscode/InputBox

InputBox

interface InputBox : QuickInput(source)

A concrete QuickInput to let the user input a text value.

Note that in many cases the more convenient window.showInputBox is easier to use. window.createInputBox should be used when window.showInputBox does not offer the required flexibility.

Online Documentation

Properties

Link copied to clipboard
abstract var busy: Boolean

Determines if the UI should show a progress indicator. Defaults to false.

Link copied to clipboard
abstract var buttons: ReadonlyArray<QuickInputButton>

Buttons for actions in the UI.

Link copied to clipboard
abstract var enabled: Boolean

Determines if the UI should allow for user input. Defaults to true.

Link copied to clipboard
abstract var ignoreFocusOut: Boolean

Determines if the UI should stay open even when losing UI focus. Defaults to false. This setting is ignored on iPad and is always false.

Link copied to clipboard
abstract val onDidAccept: Event<Void?>

An event signaling when the user indicated acceptance of the input value.

Link copied to clipboard
abstract val onDidChangeValue: Event<JsString>

An event signaling when the value has changed.

Link copied to clipboard
abstract val onDidHide: Event<Void?>

An event signaling when this input UI is hidden.

Link copied to clipboard
abstract val onDidTriggerButton: Event<QuickInputButton>

An event signaling when a button was triggered.

Link copied to clipboard
abstract var password: Boolean

Determines if the input value should be hidden. Defaults to false.

Link copied to clipboard
abstract var placeholder: String?

Optional placeholder text shown when no value has been input.

Link copied to clipboard
abstract var prompt: String?

An optional prompt text providing some ask or explanation to the user.

Link copied to clipboard
abstract var step: Int?

An optional current step count for multi-step input flows.

Link copied to clipboard
abstract var title: String?

An optional title for the input UI.

Link copied to clipboard
abstract var totalSteps: Int?

An optional total step count for multi-step input flows.

Link copied to clipboard
abstract var validationMessage: JsAny?

An optional validation message indicating a problem with the current input value.

Link copied to clipboard
abstract var value: String

The current input value.

Link copied to clipboard
abstract var valueSelection: Tuple2<JsInt, JsInt>?

Selection range in the input value.

Functions

Link copied to clipboard
abstract override fun dispose()

Dispose of this input UI and any associated resources.

Link copied to clipboard
abstract fun hide()

Hides this input UI.

Link copied to clipboard
abstract fun show()

Makes the input UI visible in its current configuration.