vscode.QuickPick - Haxe externs for Visual Studio Code

A concrete {@link 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 {@link QuickPick.canSelectMany canSelectMany} to allow for selecting multiple items.

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

Fields

`value:String`

Current value of the filter text.

`@: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.

`selectedItems:ReadOnlyArray<T>`

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

`@:optionaloptionalplaceholder:Null<String>`

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

`read onlyonDidTriggerItemButton:Event<QuickPickItemButtonEvent<T>>`

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

`read onlyonDidTriggerButton:Event<QuickInputButton>`

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

`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 of the filter text has changed.

`read onlyonDidChangeSelection:Event<ReadOnlyArray<T>>`

An event signaling when the selected items have changed.

`read onlyonDidChangeActive:Event<ReadOnlyArray<T>>`

An event signaling when the active items have changed.

`read onlyonDidAccept:Event<Void>`

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

`matchOnDetail:Bool`

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

`matchOnDescription:Bool`

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

`@:optionaloptionalkeepScrollPosition:Null<Bool>`

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

`items:ReadOnlyArray<T>`

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

`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.

`canSelectMany:Bool`

If multiple items can be selected at the same time. Defaults to false.

`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.

`activeItems:ReadOnlyArray<T>`

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

typedef QuickPick<T>

package vscode