Skip to main content

Interface: QuickPickItem

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

Properties​

alwaysShow?​

optional alwaysShow: boolean

Always show this item.

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

Defined in​

packages/extension-api/src/extension-api.d.ts:1328

buttons?​

optional buttons: readonly QuickInputButton[]

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

Defined in​

packages/extension-api/src/extension-api.d.ts:1338

description?​

optional description: string

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

Defined in​

packages/extension-api/src/extension-api.d.ts:1300

detail?​

optional detail: string

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

Defined in​

packages/extension-api/src/extension-api.d.ts:1308

kind?​

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

Defined in​

packages/extension-api/src/extension-api.d.ts:1292

label​

label: string

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

Defined in​

packages/extension-api/src/extension-api.d.ts:1286

picked?​

optional picked: boolean

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

Defined in​

packages/extension-api/src/extension-api.d.ts:1321