Skip to main content

Interface: CustomPick<T>

A concrete CustomPick to let the user pick an item from a list of items of type T. The items are rendered using a custom UI.

Type parameters​

• T extends CustomPickItem

Properties​

canSelectMany​

canSelectMany: boolean

If multiple items can be selected at the same time. Defaults to false.

Source​

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

description?​

optional description: string

An optional human-readable string which is rendered less prominent in a separate line.

Source​

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

hideItemSections​

hideItemSections: boolean

If the additional sections of an item should be hidden by default when the dialog opens up. The user can still open them by clicking on the 'show more' button. Defaults to false.

Source​

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

icon?​

optional icon: string | object

An optional base64 PNG image

Source​

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

items​

items: T[]

Items to pick from. This can be read and updated by the extension.

Source​

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

minHeight?​

optional minHeight: string

When a custompick is closed (the sections are hidden) it is possible to set a minimum height so to force different items to have the same height. It must be set using pixels or percentage (e.g 100px or 50%) Use it carefully as it could break the layout.

Source​

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

onDidConfirmSelection​

readonly onDidConfirmSelection: Event<number[]>

An event signaling when the user indicated confirmation of the selected item(s) index(es).

Source​

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

onDidHide​

readonly onDidHide: Event<void>

An event signaling when this input UI is hidden.

Source​

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

title?​

optional title: string

An optional human-readable string which is rendered prominent.

Source​

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

Methods​

dispose()​

dispose(): void

Dispose and free associated resources. Call CustomPick.hide.

Returns​

void

Source​

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

hide()​

hide(): void

Hides the custom pick.

Returns​

void

Source​

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

show()​

show(): void

Shows the custom pick.

Returns​

void

Source​

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