Skip to main content

filePickerAPI

MS Code Extension API


MS Code Extension API / core/extensionAPI/modules/window/filePickerAPI

core/extensionAPI/modules/window/filePickerAPI

Functions

createFilePickerAPI()

createFilePickerAPI(): object

Defined in: core/extensionAPI/modules/window/filePickerAPI.ts:6

Returns

onDidCloseFilePicker

onDidCloseFilePicker: (handler) => object

Fired when the file/folder picker dialog is closed.

Parameters
handler

(selectedPath) => void

Callback function receiving the selected path as a string, or null if the dialog was cancelled.

Returns

object

A disposable object to unregister the listener.

dispose

dispose: () => void

Returns

void

onDidOpenFilePicker

onDidOpenFilePicker: (handler) => object

Fired when the file/folder picker dialog is opened.

Parameters
handler

(options) => void

Callback function receiving the PickerOptions used to open the dialog.

Returns

object

A disposable object to unregister the listener.

dispose

dispose: () => void

Returns

void

showOpenDialog

showOpenDialog: (options) => Promise<string | null>

Shows a file or folder picker dialog to the user.

Parameters
options

PickerOptions

Configuration for the picker (e.g., mode, title).

Returns

Promise<string | null>

A promise that resolves to the selected path, or null if the user cancelled.