Skip to main content

Interface: QuickPickOptions

Options to configure the behavior of the quick pick UI.

Properties​

canPickMany?​

canPickMany?: boolean

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

Source​

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

ignoreFocusOut?​

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.

Source​

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

matchOnDescription?​

matchOnDescription?: boolean

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

Source​

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

matchOnDetail?​

matchOnDetail?: boolean

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

Source​

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

placeHolder?​

placeHolder?: string

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

Source​

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

title?​

title?: string

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

Source​

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

Methods​

onDidSelectItem()?​

optional onDidSelectItem(item): any

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

Parameters​

• item: string | QuickPickItem

Returns​

any

Source​

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