跳转到主内容

接口:QuickPickItem

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

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

属性

alwaysShow?

可选 alwaysShow: boolean

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

始终显示此项。

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


buttons?

可选 buttons: 只读 QuickInputButton[]

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

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

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


description?

可选 description: string

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

人类可读的字符串,在同一行中呈现时不太突出。支持通过 $(<name>) 语法渲染 ThemeIcon 主题图标。

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


detail?

可选 detail: string

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

人类可读的字符串,在单独的行中呈现时不太突出。支持通过 $(<name>) 语法渲染 ThemeIcon 主题图标。

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


kind?

可选 kind: QuickPickItemKind

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

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


label

label: string

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

人类可读的字符串,突出显示。支持通过 $(<name>) 语法渲染 ThemeIcon 主题图标。


picked?

可选 picked: boolean

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

可选标志,指示此项是否为初始选择项。仅在使用 showQuickPick() API 时生效。要使用 window.createQuickPick createQuickPick() API 实现相同的功能,只需将 QuickPick.selectedItems 设置为您希望初始选择的项即可。(注意:仅当选择框允许选择多个项时才生效。)

参见

QuickPickOptions.canPickMany

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