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 external var busy: Boolean

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

buttons

abstract external var buttons: ReadonlyArray<QuickInputButton>

Buttons for actions in the UI.

enabled

abstract external var enabled: Boolean

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

ignoreFocusOut

abstract external 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.

onDidAccept

abstract external val onDidAccept: Event<Void>

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

onDidChangeValue

abstract external val onDidChangeValue: Event<JsString>

An event signaling when the value has changed.

onDidHide

abstract external val onDidHide: Event<Void>

An event signaling when this input UI is hidden.

onDidTriggerButton

abstract external val onDidTriggerButton: Event<QuickInputButton>

An event signaling when a button was triggered.

password

abstract external var password: Boolean

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

placeholder

abstract external var placeholder: String?

Optional placeholder text shown when no value has been input.

prompt

abstract external var prompt: String?

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

step

abstract external var step: Int?

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

title

abstract external var title: String?

An optional title for the input UI.

totalSteps

abstract external var totalSteps: Int?

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

validationMessage

abstract external var validationMessage: JsAny?

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

value

abstract external var value: String

The current input value.

valueSelection

abstract external var valueSelection: Tuple2<JsInt, JsInt>?

Selection range in the input value.

Functions

dispose

abstract external override fun dispose()

Dispose of this input UI and any associated resources.

hide

abstract external fun hide()

Hides this input UI.

show

abstract external fun show()

Makes the input UI visible in its current configuration.