跳至主要内容

接口: QuickPickItem

表示可以从项目列表中选择的项目。

属性

alwaysShow?

可选 alwaysShow: 布尔型

始终显示此项目。

注意: 当 kind 设置为 QuickPickItemKind.Separator 时,此属性将被忽略。

定义于

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


buttons?

可选 buttons: readonly QuickInputButton[]

此特定项目上将呈现的可选按钮。 这些按钮将在点击时触发 QuickPickItemButtonEvent。 仅当使用由 window.createQuickPick createQuickPick() API 创建的快速选择时,才会呈现按钮。 使用 showQuickPick() API 时,不会呈现按钮。

注意: 当 kind 设置为 QuickPickItemKind.Separator 时,此属性将被忽略。

定义于

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


description?

可选 description: 字符串

一个以较低优先级呈现的人类可读字符串,位于同一行。 支持通过 $(<name>) 语法呈现 ThemeIcon 主题图标。

注意: 当 kind 设置为 QuickPickItemKind.Separator 时,此属性将被忽略。

定义于

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


detail?

可选 detail: 字符串

一个以较低优先级呈现的人类可读字符串,位于单独的行。 支持通过 $(<name>) 语法呈现 ThemeIcon 主题图标。

注意: 当 kind 设置为 QuickPickItemKind.Separator 时,此属性将被忽略。

定义于

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


kind?

可选 kind: QuickPickItemKind

将确定此项目如何在快速选择中呈现的 QuickPickItem 类型。 如果未指定,则默认值为 QuickPickItemKind.Default

定义于

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


label

label: 字符串

一个以较高优先级呈现的人类可读字符串。 支持通过 $(<name>) 语法呈现 ThemeIcon 主题图标。

定义于

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


picked?

可选 picked: 布尔型

可选标志,指示此项目是否最初被选中。 这仅在使用 showQuickPick() API 时适用。 要使用 window.createQuickPick createQuickPick() API 执行相同操作,只需将 QuickPick.selectedItems 设置为要最初选中的项目。(注意: 这仅在选择器允许进行多选时适用。)

参见

QuickPickOptions.canPickMany

注意: 当 kind 设置为 QuickPickItemKind.Separator 时,此属性将被忽略。

定义于

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