Skip to main content

filePickerStore

MS Code Extension API

MS Code Extension API / store/filePickerStore

store/filePickerStore

Interfaces​

FileFilter​

Defined in: store/filePickerStore.ts:11

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: store/filePickerStore.ts:15

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

label​

label: string

Defined in: store/filePickerStore.ts:13

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

PickerOptions​

Defined in: store/filePickerStore.ts:18

Properties​

allowCreate?​

optional allowCreate?: boolean

Defined in: store/filePickerStore.ts:51

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

buttonText?​

optional buttonText?: string

Defined in: store/filePickerStore.ts:33

Override the confirm-button label.

defaultName?​

optional defaultName?: string

Defined in: store/filePickerStore.ts:43

Pre-filled filename for saveAs mode.

defaultPath?​

optional defaultPath?: string

Defined in: store/filePickerStore.ts:41

Starting directory. Defaults to 'ROOT'.

fileNamePlaceholder?​

optional fileNamePlaceholder?: string

Defined in: store/filePickerStore.ts:45

Placeholder text for the saveAs filename input.

filters?​

optional filters?: FileFilter[]

Defined in: store/filePickerStore.ts:36

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

icon?​

optional icon?: string

Defined in: store/filePickerStore.ts:31

Header icon name from IconRegistry.

mode​

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

Defined in: store/filePickerStore.ts:26

Interaction mode:

  • file → pick one existing file → resolves string | null
  • folder → navigate then confirm → resolves string | null
  • saveAs → choose directory + name → resolves string | null (full path)
  • multiFile → pick multiple files → resolves string[] | null
requiredFiles?​

optional requiredFiles?: string[]

Defined in: store/filePickerStore.ts:38

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

showHidden?​

optional showHidden?: boolean

Defined in: store/filePickerStore.ts:53

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

title?​

optional title?: string

Defined in: store/filePickerStore.ts:29

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

Variables​

useFilePickerStore​

const useFilePickerStore: UseBoundStore<StoreApi<FilePickerState>>

Defined in: store/filePickerStore.ts:75