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.
Properties
Active items. This can be read and updated by the extension.
Buttons for actions in the UI.
If multiple items can be selected at the same time. Defaults to false.
If the UI should stay open even when loosing UI focus. Defaults to false. This setting is ignored on iPad and is always false.
Items to pick from. This can be read and updated by the extension.
An optional flag to maintain the scroll position of the quick pick when the quick pick items are updated. Defaults to false.
If the filter text should also be matched against the description of the items. Defaults to false.
If the filter text should also be matched against the detail of the items. Defaults to false.
An event signaling when the user indicated acceptance of the selected item(s).
An event signaling when the active items have changed.
An event signaling when the selected items have changed.
An event signaling when the value of the filter text has changed.
An event signaling when a top level button (buttons stored in buttons) was triggered. This event does not fire for buttons on a QuickPickItem.
An event signaling when a button in a particular QuickPickItem was triggered. This event does not fire for buttons in the title bar.
Optional placeholder shown in the filter textbox when no filter has been entered.
Selected items. This can be read and updated by the extension.
An optional total step count.
Functions
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.
Hides this input UI. This will also fire an QuickInput.onDidHide event.
Makes the input UI visible in its current configuration. Any other input UI will first fire an QuickInput.onDidHide event.