Interface: QuickPickItem

Defined in: packages/extension-api/src/extension-api.d.ts:1508

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

Properties

alwaysShow?

optional alwaysShow: boolean

Defined in: packages/extension-api/src/extension-api.d.ts:1555

Always show this item.

Note: this property is ignored when kind is set to QuickPickItemKind.Separator

---

buttons?

optional buttons: readonly QuickInputButton[]

Defined in: packages/extension-api/src/extension-api.d.ts:1565

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 window.createQuickPick createQuickPick() API. Buttons are not rendered when using the showQuickPick() API.

Note: this property is ignored when kind is set to QuickPickItemKind.Separator

---

description?

optional description: string

Defined in: packages/extension-api/src/extension-api.d.ts:1527

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

Note: this property is ignored when kind is set to QuickPickItemKind.Separator

---

detail?

optional detail: string

Defined in: packages/extension-api/src/extension-api.d.ts:1535

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

Note: this property is ignored when kind is set to QuickPickItemKind.Separator

---

kind?

optional kind: QuickPickItemKind

Defined in: packages/extension-api/src/extension-api.d.ts:1519

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

---

label

label: string

Defined in: packages/extension-api/src/extension-api.d.ts:1513

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

---

picked?

optional picked: boolean

Defined in: packages/extension-api/src/extension-api.d.ts:1548

Optional flag indicating if this item is picked initially. This is only honored when using the showQuickPick() API. To do the same thing with the window.createQuickPick 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.)

See

QuickPickOptions.canPickMany

Note: this property is ignored when kind is set to QuickPickItemKind.Separator