Skip to main content

quickPickAPI

MS Code Extension API

MS Code Extension API / core/extensionAPI/modules/window/quickPickAPI

core/extensionAPI/modules/window/quickPickAPI

Functions​

createQuickPickAPI()​

createQuickPickAPI(): object

Defined in: core/extensionAPI/modules/window/quickPickAPI.ts:10

Factory function to create the QuickPick API. Allows extensions to prompt the user to select from a list of items using the Palette UI.

Returns​

showQuickPick​

showQuickPick: (items, options?) => Promise<QuickPickItem | undefined>

Shows a selection list to the user.

Parameters​
items​

QuickPickItem[]

The array of items to display in the list.

options?​

Configuration options for the QuickPick.

placeHolder?​

string

Text to display in the input field as a hint.

Returns​

Promise<QuickPickItem | undefined>

A promise that resolves to the selected item, or undefined if the user cancels the selection.