Interface: QuickPickOptions

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

Options to configure the behavior of the quick pick UI.

Properties

canPickMany?

optional canPickMany: boolean

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

An optional flag to make the picker accept multiple selections, if true the result is an array of picks.

---

ignoreFocusOut?

optional ignoreFocusOut: boolean

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

Set to true to keep the picker open when focus moves to another part of the editor or to another window. This setting is ignored on iPad and is always false.

---

matchOnDescription?

optional matchOnDescription: boolean

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

An optional flag to include the description when filtering the picks.

---

matchOnDetail?

optional matchOnDetail: boolean

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

An optional flag to include the detail when filtering the picks.

---

placeHolder?

optional placeHolder: string

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

An optional string to show as placeholder in the input box to guide the user what to pick on.

---

title?

optional title: string

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

An optional string that represents the title of the quick pick.

Methods

onDidSelectItem()?

optional onDidSelectItem(item): any

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

An optional function that is invoked whenever an item is selected.

Parameters

item

string | QuickPickItem

Returns

any