Skip to main content

modules/window/quickPick

Interfaces​

InputBoxOptions​

Defined in: modules/window/quickPick.d.ts:69

Properties​

placeHolder?​

optional placeHolder?: string

Defined in: modules/window/quickPick.d.ts:71

Text to display in the input field as a hint.

QuickPickItem​

Defined in: modules/window/quickPick.d.ts:8

Represents an item that can be selected from a Quick Pick palette.

Properties​

data?​

optional data?: any

Defined in: modules/window/quickPick.d.ts:61

Optional custom data payload attached to the item.

description?​

optional description?: string

Defined in: modules/window/quickPick.d.ts:16

A secondary description displayed underneath or next to the label.

focusStyle?​

optional focusStyle?: "normal" | "highlight"

Defined in: modules/window/quickPick.d.ts:43

Visual focus styling.

Default​
'highlight'
iconClass?​

optional iconClass?: string

Defined in: modules/window/quickPick.d.ts:31

Custom CSS class for the item's icon.

id​

id: string

Defined in: modules/window/quickPick.d.ts:10

A unique identifier for the item.

indent?​

optional indent?: boolean

Defined in: modules/window/quickPick.d.ts:25

Whether the item should be visually indented.

inlineDetail?​

optional inlineDetail?: string

Defined in: modules/window/quickPick.d.ts:19

Additional detail displayed inline with the label.

keepOpen?​

optional keepOpen?: boolean

Defined in: modules/window/quickPick.d.ts:46

If true, selecting this item will NOT close the Quick Pick palette.

label​

label: string

Defined in: modules/window/quickPick.d.ts:13

The primary text displayed for the item.

leftIcon?​

optional leftIcon?: string

Defined in: modules/window/quickPick.d.ts:34

Codicon name to display on the left side (e.g., 'file', 'gear').

onFocus?​

optional onFocus?: () => void

Defined in: modules/window/quickPick.d.ts:55

Callback fired when this item is focused/highlighted via keyboard navigation.

Returns​

void

onRightIconClick?​

optional onRightIconClick?: (e) => void

Defined in: modules/window/quickPick.d.ts:58

Callback fired when the right icon is clicked.

Parameters​
e​

any

Returns​

void

onSelect?​

optional onSelect?: () => void

Defined in: modules/window/quickPick.d.ts:52

Callback fired when this specific item is selected.

Returns​

void

readonly?​

optional readonly?: boolean

Defined in: modules/window/quickPick.d.ts:49

If true, the item is displayed but cannot be selected.

rightIcon?​

optional rightIcon?: string

Defined in: modules/window/quickPick.d.ts:37

Codicon name to display on the right side.

shortcut?​

optional shortcut?: string

Defined in: modules/window/quickPick.d.ts:40

Keyboard shortcut hint to display (e.g., 'Ctrl+P').

suffix?​

optional suffix?: string

Defined in: modules/window/quickPick.d.ts:22

Text displayed at the far right of the item row.

type?​

optional type?: "separator" | "item"

Defined in: modules/window/quickPick.d.ts:28

Defines if this is a selectable item or a visual separator.

QuickPickOptions​

Defined in: modules/window/quickPick.d.ts:64

Properties​

placeHolder?​

optional placeHolder?: string

Defined in: modules/window/quickPick.d.ts:66

Text to display in the input field as a hint.

References​

ActivityBarItemOptions​

Re-exports ActivityBarItemOptions

app​

Re-exports app

authentication​

Re-exports authentication

BookmarkFolder​

Re-exports BookmarkFolder

CommandMetadata​

Re-exports CommandMetadata

commands​

Re-exports commands

CommitOptions​

Re-exports CommitOptions

ConfigurationProperty​

Re-exports ConfigurationProperty

CopyOptions​

Re-exports CopyOptions

Diagnostic​

Re-exports Diagnostic

DiagnosticCollection​

Re-exports DiagnosticCollection

DiagnosticSeverity​

Re-exports DiagnosticSeverity

Disposable​

Re-exports Disposable

DocumentSymbol​

Re-exports DocumentSymbol

ExtensionContext​

Re-exports ExtensionContext

ExtensionInfo​

Re-exports ExtensionInfo

extensions​

Re-exports extensions

FileDecoration​

Re-exports FileDecoration

FileFilter​

Re-exports FileFilter

FileStat​

Re-exports FileStat

FileSystemAPI​

Re-exports FileSystemAPI

FindOptions​

Re-exports FindOptions

fs​

Re-exports fs

git​

Re-exports git

GitBranch​

Re-exports GitBranch

GitChangedFile​

Re-exports GitChangedFile

GitCommit​

Re-exports GitCommit

GitFileStatus​

Re-exports GitFileStatus

GitHubUser​

Re-exports GitHubUser

GitRepository​

Re-exports GitRepository

GitSortMode​

Re-exports GitSortMode

GitStash​

Re-exports GitStash

IConfigurationSection​

Re-exports IConfigurationSection

IconThemeDefinition​

Re-exports IconThemeDefinition

IconThemeMap​

Re-exports IconThemeMap

languages​

Re-exports languages

lsp​

Re-exports lsp

LspServerConfig​

Re-exports LspServerConfig

Re-exports MenuItem

Re-exports menus

ModalOptions​

Re-exports ModalOptions

MSCodeUIColors​

Re-exports MSCodeUIColors

MultiPickerOptions​

Re-exports MultiPickerOptions

NotificationAction​

Re-exports NotificationAction

OutputChannel​

Re-exports OutputChannel

PickerOptions​

Re-exports PickerOptions

Position​

Re-exports Position

ProgressNotification​

Re-exports ProgressNotification

RecentWorkspace​

Re-exports RecentWorkspace

ReplaceOptions​

Re-exports ReplaceOptions

ResolvedIcon​

Re-exports ResolvedIcon

Re-exports search

SearchFileResult​

Re-exports SearchFileResult

SearchMatch​

Re-exports SearchMatch

Selection​

Re-exports Selection

SettingOption​

Re-exports SettingOption

SettingType​

Re-exports SettingType

SidebarPanelDef​

Re-exports SidebarPanelDef

SidebarPanelHeader​

Re-exports SidebarPanelHeader

SidebarSectionContent​

Re-exports SidebarSectionContent

SidebarSectionContext​

Re-exports SidebarSectionContext

SidebarSectionDef​

Re-exports SidebarSectionDef

SidebarState​

Re-exports SidebarState

SilentSearchOptions​

Re-exports SilentSearchOptions

StashOptions​

Re-exports StashOptions

StatusBarAlignment​

Re-exports StatusBarAlignment

StatusBarItemController​

Re-exports StatusBarItemController

StatusBarItemOptions​

Re-exports StatusBarItemOptions

SymbolKind​

Re-exports SymbolKind

SymbolProvider​

Re-exports SymbolProvider

Tab​

Re-exports Tab

TabDiffData​

Re-exports TabDiffData

TabOptions​

Re-exports TabOptions

TabType​

Re-exports TabType

TaskExecution​

Re-exports TaskExecution

TaskOptions​

Re-exports TaskOptions

tasks​

Re-exports tasks

Terminal​

Re-exports Terminal

TerminalExitStatus​

Re-exports TerminalExitStatus

TerminalOptions​

Re-exports TerminalOptions

termis​

Re-exports termis

TermisView​

Re-exports TermisView

TextDocument​

Re-exports TextDocument

TextEditor​

Re-exports TextEditor

TextEditorEdit​

Re-exports TextEditorEdit

TextEditorOptions​

Re-exports TextEditorOptions

ThemeDefinition​

Re-exports ThemeDefinition

themes​

Re-exports themes

TokenColor​

Re-exports TokenColor

TreeDataProvider​

Re-exports TreeDataProvider

TreeItem​

Re-exports TreeItem

TreeView​

Re-exports TreeView

TreeViewOptions​

Re-exports TreeViewOptions

window​

Re-exports window

workspace​

Re-exports workspace

WorkspaceConfiguration​

Re-exports WorkspaceConfiguration

WorkspaceFolder​

Re-exports WorkspaceFolder

WriteOptions​

Re-exports WriteOptions