跳至主要内容

接口: CustomPick<T>

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

类型参数

T 扩展 CustomPickItem

属性

canSelectMany

canSelectMany: boolean

如果可以同时选择多个项目。默认为 false。

定义在

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


description?

可选 description: string

一个可选的人类可读字符串,它在单独的一行中以不太突出的方式呈现。

定义在

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


hideItemSections

hideItemSections: boolean

如果项目的其他部分应在对话框打开时默认隐藏。用户仍然可以通过点击“显示更多”按钮打开它们。默认为 false。

定义在

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


icon?

可选 icon: string | object

一个可选的 base64 PNG 图像

定义在

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


items

items: T[]

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

定义在

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


minHeight?

可选 minHeight: string

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

定义在

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


onDidConfirmSelection

只读 onDidConfirmSelection: Event<number[]>

当用户指示对所选项目索引进行确认时,一个发出信号的事件。

定义在

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


onDidHide

只读 onDidHide: Event<void>

当此输入 UI 隐藏时,一个发出信号的事件。

定义在

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


title?

可选 title: string

一个可选的人类可读字符串,它以突出的方式呈现。

定义在

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

方法

dispose()

dispose(): void

释放和释放关联的资源。调用 CustomPick.hide.

返回值

void

定义在

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


hide()

hide(): void

隐藏自定义选择。

返回值

void

定义于

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


show()

show(): void

显示自定义选择器。

返回值

void

定义于

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