QuickPickItem class

Represents an item that can be selected from a list of items.

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

Constructors

QuickPickItem({String? label, QuickPickItemKind? kind, Object? iconPath, String? description, String? detail, bool? picked, bool? alwaysShow, List<QuickInputButton>? buttons})
factory

Properties

alwaysShow ↔ bool?

Available on QuickPickItem, provided by the QuickPickItem$Typings extension

Always show this item.
getter/setter pair
buttons ↔ List<QuickInputButton>?

Available on QuickPickItem, provided by the QuickPickItem$Typings extension

Optional buttons that will be rendered on this particular item. These buttons will trigger an {@link QuickPickItemButtonEvent} when clicked. Buttons are only rendered when using a quickpick created by the {@link window.createQuickPick createQuickPick()} API. Buttons are not rendered when using the {@link window.showQuickPick showQuickPick()} API.
getter/setter pair
description ↔ String?

Available on QuickPickItem, provided by the QuickPickItem$Typings extension

A human-readable string which is rendered less prominent in the same line. Supports rendering of {@link ThemeIcon theme icons} via the $(<name>)-syntax.
getter/setter pair
detail ↔ String?

Available on QuickPickItem, provided by the QuickPickItem$Typings extension

A human-readable string which is rendered less prominent in a separate line. Supports rendering of {@link ThemeIcon theme icons} via the $(<name>)-syntax.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
iconPath ↔ Object?

Available on QuickPickItem, provided by the QuickPickItem$Typings extension

The icon path or {@link ThemeIcon} for the QuickPickItem.
getter/setter pair
kind ↔ QuickPickItemKind?

Available on QuickPickItem, provided by the QuickPickItem$Typings extension

The kind of QuickPickItem that will determine how this item is rendered in the quick pick. When not specified, the default is {@link QuickPickItemKind.Default}.
getter/setter pair
label ↔ String

Available on QuickPickItem, provided by the QuickPickItem$Typings extension

A human-readable string which is rendered prominent. Supports rendering of {@link ThemeIcon theme icons} via the $(<name>)-syntax.
getter/setter pair
picked ↔ bool?

Available on QuickPickItem, provided by the QuickPickItem$Typings extension

Optional flag indicating if this item is picked initially. This is only honored when using the {@link window.showQuickPick showQuickPick()} API. To do the same thing with the {@link window.createQuickPick createQuickPick()} API, simply set the {@link QuickPick.selectedItems} to the items you want picked initially. (Note: This is only honored when the picker allows multiple selections.)
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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