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.
Defined in
packages/extension-api/src/extension-api.d.ts:1640
description?
optionaldescription:string
An optional human-readable string which is rendered less prominent in a separate line.
Defined in
packages/extension-api/src/extension-api.d.ts:1628
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.
Defined in
packages/extension-api/src/extension-api.d.ts:1646
icon?
optionalicon:string| {dark:string;light:string; }
An optional base64 PNG image
Defined in
packages/extension-api/src/extension-api.d.ts:1632
items
items:
T[]
Items to pick from. This can be read and updated by the extension.
Defined in
packages/extension-api/src/extension-api.d.ts:1636
minHeight?
optionalminHeight: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.
Defined in
packages/extension-api/src/extension-api.d.ts:1652
onDidConfirmSelection
readonlyonDidConfirmSelection:Event<number[]>
An event signaling when the user indicated confirmation of the selected item(s) index(es).
Defined in
packages/extension-api/src/extension-api.d.ts:1656
onDidHide
readonlyonDidHide:Event<void>
An event signaling when this input UI is hidden.
Defined in
packages/extension-api/src/extension-api.d.ts:1660
title?
optionaltitle:string
An optional human-readable string which is rendered prominent.
Defined in
packages/extension-api/src/extension-api.d.ts:1624
Methods
dispose()
dispose():
void
Dispose and free associated resources. Call CustomPick.hide.
Returns
void
Defined in
packages/extension-api/src/extension-api.d.ts:1674
hide()
hide():
void
Hides the custom pick.
Returns
void
Defined in
packages/extension-api/src/extension-api.d.ts:1668
show()
show():
void
Shows the custom pick.
Returns
void