QuickInput

A light-weight user input UI that is initially not visible. After configuring it through its properties the extension can make it visible by calling QuickInput.show.

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

A user pressing Enter or some other gesture implying acceptance of the current state does not automatically hide this UI component. It is up to the extension to decide whether to accept the user's input and if the UI should indeed be hidden through a call to QuickInput.hide.

When the extension no longer needs this input UI, it should QuickInput.dispose it to allow for freeing up any resources associated with it.

See QuickPick and InputBox for concrete UIs.

Online Documentation

Inheritors

Properties

Link copied to clipboard
abstract var busy: Boolean

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

Link copied to clipboard
abstract var enabled: Boolean

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

Link copied to clipboard
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.

Link copied to clipboard
abstract var onDidHide: Event<Void>

An event signaling when this input UI is hidden.

Link copied to clipboard
abstract var step: Int?

An optional current step count.

Link copied to clipboard
abstract var title: String?

An optional title.

Link copied to clipboard
abstract var totalSteps: Int?

An optional total step count.

Functions

Link copied to clipboard
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.

Link copied to clipboard
abstract fun hide()

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

Link copied to clipboard
abstract fun show()

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