QuickPick<T extends QuickPickItem> class

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.canSelectManycanSelectMany} 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.

Implemented types
Available extensions
Annotations
  • @JS()
  • @staticInterop
  • @anonymous

Constructors

QuickPick({String? value, String? placeholder, Event<String>? onDidChangeValue, Event<void>? onDidAccept, List<QuickInputButton>? buttons, Event<QuickInputButton>? onDidTriggerButton, Event<QuickPickItemButtonEvent>? onDidTriggerItemButton, List? items, bool? canSelectMany, bool? matchOnDescription, bool? matchOnDetail, bool? keepScrollPosition, List? activeItems, Event<List>? onDidChangeActive, List? selectedItems, Event<List>? onDidChangeSelection, String? title, num? step, num? totalSteps, bool? enabled, bool? busy, bool? ignoreFocusOut, Event<void>? onDidHide, void show()?, void hide()?, void dispose()?})
factory

Properties

activeItems ↔ List<T>

Available on QuickPick<T>, provided by the QuickPick$Typings extension

Active items. This can be read and updated by the extension.
getter/setter pair
busy ↔ bool

Available on QuickInput, provided by the QuickInput$Typings extension

If the UI should show a progress indicator. Defaults to false.
getter/setter pair
buttons ↔ List<QuickInputButton>

Available on QuickPick<T>, provided by the QuickPick$Typings extension

Buttons for actions in the UI.
getter/setter pair
canSelectMany ↔ bool

Available on QuickPick<T>, provided by the QuickPick$Typings extension

If multiple items can be selected at the same time. Defaults to false.
getter/setter pair
dispose ↔ void Function()

Available on QuickInput, provided by the QuickInput$Typings extension

getter/setter pair
enabled ↔ bool

Available on QuickInput, provided by the QuickInput$Typings extension

If the UI should allow for user input. Defaults to true.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
hide ↔ void Function()

Available on QuickInput, provided by the QuickInput$Typings extension

getter/setter pair
ignoreFocusOut ↔ bool

Available on QuickInput, provided by the QuickInput$Typings extension

If the UI should stay open even when loosing UI focus. Defaults to false. This setting is ignored on iPad and is always false.
getter/setter pair
items ↔ List<T>

Available on QuickPick<T>, provided by the QuickPick$Typings extension

Items to pick from. This can be read and updated by the extension.
getter/setter pair
keepScrollPosition ↔ bool?

Available on QuickPick<T>, provided by the QuickPick$Typings extension

An optional flag to maintain the scroll position of the quick pick when the quick pick items are updated. Defaults to false.
getter/setter pair
matchOnDescription ↔ bool

Available on QuickPick<T>, provided by the QuickPick$Typings extension

If the filter text should also be matched against the description of the items. Defaults to false.
getter/setter pair
matchOnDetail ↔ bool

Available on QuickPick<T>, provided by the QuickPick$Typings extension

If the filter text should also be matched against the detail of the items. Defaults to false.
getter/setter pair
onDidAccept → Event<void>

Available on QuickPick<T>, provided by the QuickPick$Typings extension

An event signaling when the user indicated acceptance of the selected item(s).
no setter
onDidChangeActive → Event<List<T>>

Available on QuickPick<T>, provided by the QuickPick$Typings extension

An event signaling when the active items have changed.
no setter
onDidChangeSelection → Event<List<T>>

Available on QuickPick<T>, provided by the QuickPick$Typings extension

An event signaling when the selected items have changed.
no setter
onDidChangeValue → Event<String>

Available on QuickPick<T>, provided by the QuickPick$Typings extension

An event signaling when the value of the filter text has changed.
no setter
onDidHide ↔ Event<void>

Available on QuickInput, provided by the QuickInput$Typings extension

An event signaling when this input UI is hidden.
getter/setter pair
onDidTriggerButton → Event<QuickInputButton>

Available on QuickPick<T>, provided by the QuickPick$Typings extension

An event signaling when a button in the title bar was triggered. This event does not fire for buttons on a {@link QuickPickItem}.
no setter
onDidTriggerItemButton → Event<QuickPickItemButtonEvent<T>>

Available on QuickPick<T>, provided by the QuickPick$Typings extension

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

Available on QuickPick<T>, provided by the QuickPick$Typings extension

Optional placeholder shown in the filter textbox when no filter has been entered.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedItems ↔ List<T>

Available on QuickPick<T>, provided by the QuickPick$Typings extension

Selected items. This can be read and updated by the extension.
getter/setter pair
show ↔ void Function()

Available on QuickInput, provided by the QuickInput$Typings extension

getter/setter pair
step ↔ num?

Available on QuickInput, provided by the QuickInput$Typings extension

An optional current step count.
getter/setter pair
title ↔ String?

Available on QuickInput, provided by the QuickInput$Typings extension

An optional title.
getter/setter pair
totalSteps ↔ num?

Available on QuickInput, provided by the QuickInput$Typings extension

An optional total step count.
getter/setter pair
value ↔ String

Available on QuickPick<T>, provided by the QuickPick$Typings extension

Current value of the filter text.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited