View source

typedef InputBox

package vscode

A concrete {@link QuickInput} to let the user input a text value.

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

Fields

value:String

Current input value.

@:optionaloptionalvalidationMessage:Null<String>

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

@:optionaloptionaltotalSteps:Null<Int>

An optional total step count.

@:optionaloptionaltitle:Null<String>

An optional title.

@:optionaloptionalstep:Null<Int>

An optional current step count.

show():Void

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

@:optionaloptionalprompt:Null<String>

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

@:optionaloptionalplaceholder:Null<String>

Optional placeholder in the filter text.

password:Bool

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

read onlyonDidTriggerButton:Event<QuickInputButton>

An event signaling when a button was triggered.

onDidHide:Event<Void>

An event signaling when this input UI is hidden.

There are several reasons why this UI might have to be hidden and the extension will be notified through {@link QuickInput.onDidHide}. (Examples include: an explicit call to {@link QuickInput.hide}, the user pressing Esc, some other input UI opening, etc.)

read onlyonDidChangeValue:Event<String>

An event signaling when the value has changed.

read onlyonDidAccept:Event<Void>

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

ignoreFocusOut:Bool

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

hide():Void

Hides this input UI. This will also fire an {@link QuickInput.onDidHide} event.

enabled:Bool

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

Change this to false, e.g., while validating user input or loading data for the next step in user input.

dispose():Void

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.

buttons:ReadOnlyArray<QuickInputButton>

Buttons for actions in the UI.

busy:Bool

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

Change this to true, e.g., while loading more data or validating user input.