QuickPick

A concrete QuickInput to let the user pick an item from a list of items of type T. The items can be filtered through a filter text field and there is an option canSelectMany to allow for selecting multiple items.

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

Online Documentation

Properties

Link copied to clipboard
abstract var activeItems: ReadonlyArray<T>

Active items. This can be read and updated by the extension.

Link copied to clipboard
abstract var busy: Boolean

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

Link copied to clipboard

Buttons for actions in the UI.

Link copied to clipboard
abstract var canSelectMany: Boolean

If multiple items can be selected at the same time. 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 items: ReadonlyArray<T>

Items to pick from. This can be read and updated by the extension.

Link copied to clipboard

An optional flag to maintain the scroll position of the quick pick when the quick pick items are updated. Defaults to false.

Link copied to clipboard

If the filter text should also be matched against the description of the items. Defaults to false.

Link copied to clipboard
abstract var matchOnDetail: Boolean

If the filter text should also be matched against the detail of the items. Defaults to false.

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

An event signaling when the user indicated acceptance of the selected item(s).

Link copied to clipboard

An event signaling when the active items have changed.

Link copied to clipboard

An event signaling when the selected items have changed.

Link copied to clipboard

An event signaling when the value of the filter text has changed.

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

An event signaling when this input UI is hidden.

Link copied to clipboard

An event signaling when a top level button (buttons stored in buttons) was triggered. This event does not fire for buttons on a QuickPickItem.

Link copied to clipboard

An event signaling when a button in a particular QuickPickItem was triggered. This event does not fire for buttons in the title bar.

Link copied to clipboard
abstract var placeholder: String?

Optional placeholder shown in the filter textbox when no filter has been entered.

Link copied to clipboard

Selected items. This can be read and updated by the extension.

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.

Link copied to clipboard
abstract var value: String

Current value of the filter text.

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.