跳转到主内容

Interface: CustomPick<T>

定义于: packages/extension-api/src/extension-api.d.ts:1671

一个具体的 CustomPick,让用户从类型为 T 的项目列表中选择一项。项目使用自定义 UI 进行渲染。

类型参数

T

T extends CustomPickItem

属性

canSelectMany

canSelectMany: boolean

定义于: packages/extension-api/src/extension-api.d.ts:1691

是否可以同时选择多个项目。默认为 false。


description?

可选 description: string

定义于: packages/extension-api/src/extension-api.d.ts:1679

一个可选的、人类可读的字符串,以更不显眼的方式渲染在单独的一行上。


hideItemSections

hideItemSections: boolean

定义于: packages/extension-api/src/extension-api.d.ts:1697

当对话框打开时,是否默认隐藏项目的附加部分。用户仍然可以通过点击“显示更多”按钮来打开它们。默认为 false。


icon?

optional icon: string | { dark: string; light: string; }

定义于: packages/extension-api/src/extension-api.d.ts:1683

一个可选的 Base64 PNG 图像


items

items: T[]

定义于: packages/extension-api/src/extension-api.d.ts:1687

要从中选择的项目。扩展可以读取和更新此项。


minHeight?

optional minHeight: string

定义于: packages/extension-api/src/extension-api.d.ts:1703

当 custompick 关闭时(部分隐藏),可以设置最小高度,以强制不同的项目具有相同的高度。必须使用像素或百分比设置(例如 100px 或 50%)。请谨慎使用,因为它可能会破坏布局。


onDidConfirmSelection

readonly onDidConfirmSelection: Event<number[]>

定义于: packages/extension-api/src/extension-api.d.ts:1707

当用户确认选中的项目索引时触发的事件。


onDidHide

readonly onDidHide: Event<void>

定义于: packages/extension-api/src/extension-api.d.ts:1711

当此输入 UI 隐藏时触发的事件。


title?

optional title: string

定义于: packages/extension-api/src/extension-api.d.ts:1675

一个可选的、人类可读的字符串,以更显眼的方式渲染。

方法

dispose()

dispose(): void

定义于: packages/extension-api/src/extension-api.d.ts:1725

释放并清理关联的资源。调用 CustomPick.hide

返回

void


hide()

hide(): void

定义于: packages/extension-api/src/extension-api.d.ts:1719

隐藏自定义选择器。

返回值

void


show()

show(): void

定义于: packages/extension-api/src/extension-api.d.ts:1715

显示自定义选择器。

返回值

void