Skip to main content

Interface: QuickPickOptions

Options to configure the behavior of the quick pick UI.

Properties​

canPickMany?​

optional canPickMany: boolean

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

Defined in​

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

ignoreFocusOut?​

optional ignoreFocusOut: boolean

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.

Defined in​

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

matchOnDescription?​

optional matchOnDescription: boolean

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

Defined in​

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

matchOnDetail?​

optional matchOnDetail: boolean

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

Defined in​

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

placeHolder?​

optional placeHolder: string

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

Defined in​

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

title?​

optional title: string

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

Defined in​

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

Methods​

onDidSelectItem()?​

optional onDidSelectItem(item): any

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

Parameters​

item​

string | QuickPickItem

Returns​

any

Defined in​

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