QuickPickItem

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

Online Documentation

Properties

Link copied to clipboard
abstract var alwaysShow: Boolean?

Always show this item.

Link copied to clipboard

Optional buttons that will be rendered on this particular item. These buttons will trigger an QuickPickItemButtonEvent when clicked. Buttons are only rendered when using a quickpick created by the createQuickPick() API. Buttons are not rendered when using the window.showQuickPick API.

Link copied to clipboard
abstract var description: String?

A human-readable string which is rendered less prominent in the same line. Supports rendering of theme icons via the $(<name>)-syntax.

Link copied to clipboard
abstract var detail: String?

A human-readable string which is rendered less prominent in a separate line. Supports rendering of theme icons via the $(<name>)-syntax.

Link copied to clipboard
abstract var iconPath: IconPath?

The icon path or ThemeIcon for the QuickPickItem.

Link copied to clipboard
abstract var kind: QuickPickItemKind?

The kind of QuickPickItem that will determine how this item is rendered in the quick pick. When not specified, the default is QuickPickItemKind.Default.

Link copied to clipboard
abstract var label: String

A human-readable string which is rendered prominent. Supports rendering of theme icons via the $(<name>)-syntax.

Link copied to clipboard
abstract var picked: Boolean?

Optional flag indicating if this item is picked initially. This is only honored when using the window.showQuickPick API. To do the same thing with the createQuickPick() API, simply set the QuickPick.selectedItems to the items you want picked initially. (Note: This is only honored when the picker allows multiple selections.)