Active items. This can be read and updated by the extension.
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.
Buttons for actions in the UI.
If multiple items can be selected at the same time. Defaults to false.
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.
If the UI should stay open even when loosing UI focus. Defaults to false.
Items to pick from.
Optional keepIf 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.
Readonly onAn event signaling when the user indicated acceptance of the selected item(s).
Readonly onAn event signaling when the active items have changed.
Readonly onAn event signaling when the selected items have changed.
Readonly onAn event signaling when the value of the filter text has changed.
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 QuickInput.onDidHide. (Examples include: an explicit call to QuickInput.hide, the user pressing Esc, some other input UI opening, etc.)
Readonly onAn event signaling when a button was triggered.
Readonly onAn event signaling when a button in a particular QuickPickItem was triggered. This event does not fire for buttons in the title bar.
Optional placeholder in the filter text.
Selected items. This can be read and updated by the extension.
An optional current step count.
An optional title.
An optional total step count.
Current value of the filter text.
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.
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.