dots.vscode.quick-pick-item

Liking cljdoc? Tell your friends :D

ClojureScript only.

always-show?
buttons
description
detail
icon-path
kind
label
picked?
set-always-show!
set-buttons!
set-description!
set-detail!
set-icon-path!
set-kind!
set-label!
set-picked!

Represents an item that can be selected from a list of items.

Represents an item that can be selected from
a list of items.

raw docstring

always-show?^cljs

(always-show? quick-pick-item)

Always show this item.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

Returns: boolean | undefined

Always show this item.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

**Returns:** `boolean | undefined`

source raw docstring

buttons^cljs

(buttons quick-pick-item)

Optional buttons that will be rendered on this particular item. These buttons will trigger an {@link QuickPickItemButtonEvent } when clicked. Buttons are only rendered when using a quickpick created by the {@link window.createQuickPick createQuickPick()} API. Buttons are not rendered when using the {@link window.showQuickPick showQuickPick()} API.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

Returns: readonly QuickInputButton[] | undefined

Optional buttons that will be rendered on this particular item. These buttons will trigger
an {@link QuickPickItemButtonEvent } when clicked. Buttons are only rendered when using a quickpick
created by the {@link window.createQuickPick createQuickPick()} API. Buttons are not rendered when using
the {@link window.showQuickPick showQuickPick()} API.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

**Returns:** `readonly QuickInputButton[] | undefined`

source raw docstring

description^cljs

(description quick-pick-item)

A human-readable string which is rendered less prominent in the same line. Supports rendering of {@link ThemeIcon theme icons} via the $(<name>)-syntax.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

Returns: string | undefined

A human-readable string which is rendered less prominent in the same line. Supports rendering of
{@link ThemeIcon theme icons} via the `$(<name>)`-syntax.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

**Returns:** `string | undefined`

source raw docstring

detail^cljs

(detail quick-pick-item)

A human-readable string which is rendered less prominent in a separate line. Supports rendering of {@link ThemeIcon theme icons} via the $(<name>)-syntax.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

Returns: string | undefined

A human-readable string which is rendered less prominent in a separate line. Supports rendering of
{@link ThemeIcon theme icons} via the `$(<name>)`-syntax.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

**Returns:** `string | undefined`

source raw docstring

icon-path^cljs

(icon-path quick-pick-item)

The icon path or {@link ThemeIcon } for the QuickPickItem.

Returns: Uri | ThemeIcon | { light: Uri; dark: Uri; } | undefined

The icon path or {@link ThemeIcon } for the QuickPickItem.

**Returns:** `Uri | ThemeIcon | { light: Uri; dark: Uri; } | undefined`

source raw docstring

kind^cljs

(kind quick-pick-item)

The kind of QuickPickItem that will determine how this item is rendered in the quick pick. When not specified, the default is {@link QuickPickItemKind.Default }.

Returns: QuickPickItemKind | undefined

The kind of QuickPickItem that will determine how this item is rendered in the quick pick. When not specified,
the default is {@link QuickPickItemKind.Default }.

**Returns:** `QuickPickItemKind | undefined`

source raw docstring

label^cljs

(label quick-pick-item)

A human-readable string which is rendered prominent. Supports rendering of {@link ThemeIcon theme icons} via the $(<name>)-syntax.

Returns: string

A human-readable string which is rendered prominent. Supports rendering of {@link ThemeIcon theme icons} via
the `$(<name>)`-syntax.

**Returns:** `string`

source raw docstring

picked?^cljs

(picked? quick-pick-item)

Optional flag indicating if this item is picked initially. This is only honored when using the {@link window.showQuickPick showQuickPick()} API. To do the same thing with the {@link window.createQuickPick createQuickPick()} API, simply set the {@link QuickPick.selectedItems } to the items you want picked initially. (Note: This is only honored when the picker allows multiple selections.)

Returns: boolean | undefined

Optional flag indicating if this item is picked initially. This is only honored when using
the {@link window.showQuickPick showQuickPick()} API. To do the same thing with
the {@link window.createQuickPick createQuickPick()} API, simply set the {@link QuickPick.selectedItems }
to the items you want picked initially.
(*Note:* This is only honored when the picker allows multiple selections.)

**Returns:** `boolean | undefined`

source raw docstring

set-always-show!^cljs

(set-always-show! quick-pick-item value)

Always show this item.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

Always show this item.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

source raw docstring

set-buttons!^cljs

(set-buttons! quick-pick-item value)

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

Optional buttons that will be rendered on this particular item. These buttons will trigger
an {@link QuickPickItemButtonEvent } when clicked. Buttons are only rendered when using a quickpick
created by the {@link window.createQuickPick createQuickPick()} API. Buttons are not rendered when using
the {@link window.showQuickPick showQuickPick()} API.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

source raw docstring

set-description!^cljs

(set-description! quick-pick-item value)

A human-readable string which is rendered less prominent in the same line. Supports rendering of {@link ThemeIcon theme icons} via the $(<name>)-syntax.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

A human-readable string which is rendered less prominent in the same line. Supports rendering of
{@link ThemeIcon theme icons} via the `$(<name>)`-syntax.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

source raw docstring

set-detail!^cljs

(set-detail! quick-pick-item value)

A human-readable string which is rendered less prominent in a separate line. Supports rendering of {@link ThemeIcon theme icons} via the $(<name>)-syntax.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

A human-readable string which is rendered less prominent in a separate line. Supports rendering of
{@link ThemeIcon theme icons} via the `$(<name>)`-syntax.

Note: this property is ignored when {@link QuickPickItem.kind kind} is set to {@link QuickPickItemKind.Separator }

source raw docstring

set-icon-path!^cljs

(set-icon-path! quick-pick-item value)

The icon path or {@link ThemeIcon } for the QuickPickItem.

The icon path or {@link ThemeIcon } for the QuickPickItem.

source raw docstring

set-kind!^cljs

(set-kind! quick-pick-item value)

The kind of QuickPickItem that will determine how this item is rendered in the quick pick. When not specified, the default is {@link QuickPickItemKind.Default }.

The kind of QuickPickItem that will determine how this item is rendered in the quick pick. When not specified,
the default is {@link QuickPickItemKind.Default }.

source raw docstring

set-label!^cljs

(set-label! quick-pick-item value)

A human-readable string which is rendered prominent. Supports rendering of {@link ThemeIcon theme icons} via the $(<name>)-syntax.

A human-readable string which is rendered prominent. Supports rendering of {@link ThemeIcon theme icons} via
the `$(<name>)`-syntax.

source raw docstring

set-picked!^cljs

(set-picked! quick-pick-item value)

Optional flag indicating if this item is picked initially. This is only honored when using
the {@link window.showQuickPick showQuickPick()} API. To do the same thing with
the {@link window.createQuickPick createQuickPick()} API, simply set the {@link QuickPick.selectedItems }
to the items you want picked initially.
(*Note:* This is only honored when the picker allows multiple selections.)

source raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts

`Ctrl`+`k`	Jump to recent docs
`←`	Move to previous article
`→`	Move to next article
`Ctrl`+`/`	Jump to the search field

Raise an issue Browse cljdoc source Chat on Slack

× close