Skip to main content

modules/window/filePicker

Interfaces​

FileFilter​

Defined in: modules/window/filePicker.d.ts:9

A named group of file extensions for the type-filter dropdown. Use an empty extensions array to mean "All Files".

Properties​

extensions​

extensions: string[]

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

Extensions without the leading dot, e.g. ['ts', 'tsx']. Empty = all files.

label​

label: string

Defined in: modules/window/filePicker.d.ts:11

Label shown in the filter Select, e.g. "TypeScript Files"

MultiPickerOptions​

Defined in: modules/window/filePicker.d.ts:53

Extends​

Properties​

allowCreate?​

optional allowCreate?: boolean

Defined in: modules/window/filePicker.d.ts:48

Show the "New File" and "New Folder" toolbar buttons. Defaults to true; set false to hide them.

Inherited from​

PickerOptions.allowCreate

buttonText?​

optional buttonText?: string

Defined in: modules/window/filePicker.d.ts:30

Override the confirm-button label.

Inherited from​

PickerOptions.buttonText

defaultName?​

optional defaultName?: string

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

Pre-filled filename for saveAs mode.

Inherited from​

PickerOptions.defaultName

defaultPath?​

optional defaultPath?: string

Defined in: modules/window/filePicker.d.ts:38

Starting directory. Defaults to 'ROOT'.

Inherited from​

PickerOptions.defaultPath

fileNamePlaceholder?​

optional fileNamePlaceholder?: string

Defined in: modules/window/filePicker.d.ts:42

Placeholder text for the saveAs filename input.

Inherited from​

PickerOptions.fileNamePlaceholder

filters?​

optional filters?: FileFilter[]

Defined in: modules/window/filePicker.d.ts:33

File-type filters rendered as a Select in the footer. First entry is selected by default.

Inherited from​

PickerOptions.filters

icon?​

optional icon?: string

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

Header icon name from IconRegistry.

Inherited from​

PickerOptions.icon

mode​

mode: "multiFile"

Defined in: modules/window/filePicker.d.ts:56

  • Interaction mode is strictly locked to multiFile.
requiredFiles?​

optional requiredFiles?: string[]

Defined in: modules/window/filePicker.d.ts:35

Folder-mode gate: folder is only selectable when it contains every one of these filenames.

Inherited from​

PickerOptions.requiredFiles

showHidden?​

optional showHidden?: boolean

Defined in: modules/window/filePicker.d.ts:50

Show dotfiles (names starting with '.'). Defaults to false.

Inherited from​

PickerOptions.showHidden

title?​

optional title?: string

Defined in: modules/window/filePicker.d.ts:26

Modal title (auto-derived from mode when omitted).

Inherited from​

PickerOptions.title

PickerOptions​

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

Properties​

allowCreate?​

optional allowCreate?: boolean

Defined in: modules/window/filePicker.d.ts:48

Show the "New File" and "New Folder" toolbar buttons. Defaults to true; set false to hide them.

buttonText?​

optional buttonText?: string

Defined in: modules/window/filePicker.d.ts:30

Override the confirm-button label.

defaultName?​

optional defaultName?: string

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

Pre-filled filename for saveAs mode.

defaultPath?​

optional defaultPath?: string

Defined in: modules/window/filePicker.d.ts:38

Starting directory. Defaults to 'ROOT'.

fileNamePlaceholder?​

optional fileNamePlaceholder?: string

Defined in: modules/window/filePicker.d.ts:42

Placeholder text for the saveAs filename input.

filters?​

optional filters?: FileFilter[]

Defined in: modules/window/filePicker.d.ts:33

File-type filters rendered as a Select in the footer. First entry is selected by default.

icon?​

optional icon?: string

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

Header icon name from IconRegistry.

mode​

mode: "file" | "folder" | "saveAs"

Defined in: modules/window/filePicker.d.ts:23

Interaction mode:

  • file → pick one existing file
  • folder → navigate then confirm
  • saveAs → choose directory + name
requiredFiles?​

optional requiredFiles?: string[]

Defined in: modules/window/filePicker.d.ts:35

Folder-mode gate: folder is only selectable when it contains every one of these filenames.

showHidden?​

optional showHidden?: boolean

Defined in: modules/window/filePicker.d.ts:50

Show dotfiles (names starting with '.'). Defaults to false.

title?​

optional title?: string

Defined in: modules/window/filePicker.d.ts:26

Modal title (auto-derived from mode when omitted).

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

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

InputBoxOptions​

Re-exports InputBoxOptions

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

NotificationAction​

Re-exports NotificationAction

OutputChannel​

Re-exports OutputChannel

Position​

Re-exports Position

ProgressNotification​

Re-exports ProgressNotification

QuickPickItem​

Re-exports QuickPickItem

QuickPickOptions​

Re-exports QuickPickOptions

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