InputBox

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

busy

abstract var busy: Boolean

If the UI should show a progress indicator. Defaults to false.

buttons

abstract var buttons: ReadonlyArray<QuickInputButton>

Buttons for actions in the UI.

enabled

abstract var enabled: Boolean

If the UI should allow for user input. Defaults to true.

ignoreFocusOut

abstract var ignoreFocusOut: Boolean

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

onDidAccept

abstract val onDidAccept: Event<Void?>

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

onDidChangeValue

abstract val onDidChangeValue: Event<JsString>

An event signaling when the value has changed.

onDidHide

abstract var onDidHide: Event<Void?>

An event signaling when this input UI is hidden.

onDidTriggerButton

abstract val onDidTriggerButton: Event<QuickInputButton>

An event signaling when a button was triggered.

password

abstract var password: Boolean

If the input value should be hidden. Defaults to false.

placeholder

abstract var placeholder: String?

Optional placeholder shown when no value has been input.

prompt

abstract var prompt: String?

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

step

abstract var step: Int?

An optional current step count.

title

abstract var title: String?

An optional title.

totalSteps

abstract var totalSteps: Int?

An optional total step count.

validationMessage

abstract var validationMessage: JsAny?

An optional validation message indicating a problem with the current input value. By returning a string, the InputBox will use a default InputBoxValidationSeverity of Error. Returning undefined clears the validation message.

value

abstract var value: String

Current input value.

valueSelection

abstract var valueSelection: Tuple2<JsInt, JsInt>?

Selection range in the input value. Defined as tuple of two number where the first is the inclusive start index and the second the exclusive end index. When undefined the whole pre-filled value will be selected, when empty (start equals end) only the cursor will be set, otherwise the defined range will be selected.

Functions

dispose

abstract override fun dispose()

Dispose of this input UI and any associated resources. If it is still visible, it is first hidden. After this call the input UI is no longer functional and no additional methods or properties on it should be accessed. Instead a new input UI should be created.

hide

abstract fun hide()

Hides this input UI. This will also fire an QuickInput.onDidHide event.

show

abstract fun show()

Makes the input UI visible in its current configuration. Any other input UI will first fire an QuickInput.onDidHide event.