MDN self-hosted library · e01.org

Window: showDirectoryPicker() method

File System API

File System API

The showDirectoryPicker() method of the Window interface displays a directory picker which allows the user to select a directory.

Syntax

showDirectoryPicker()
showDirectoryPicker(options)

Parameters

  • options
  • : An object containing options, which are as follows:
    • id
    • : By specifying an ID, the browser can remember different directories for different IDs. If the same ID is used for another picker, the picker opens in the same directory.
    • mode
    • : A string that defaults to "read" for read-only access or "readwrite" for read and write access to the directory.
    • startIn
    • : A FileSystemHandle or a well-known directory ("desktop", "documents", "downloads", "music", "pictures", or "videos") to open the dialog in.

Return value

A Promise whose fulfillment handler receives a FileSystemDirectoryHandle object.

Exceptions

  • AbortError DOMException
  • : Thrown if the user dismisses the prompt without making a selection, or if the user agent deems the selected directory to be too sensitive or dangerous, or if the PermissionStatus.state for the selected directory is not "granted" in the specified mode.
  • SecurityError DOMException
  • : Thrown if the call was blocked by the same-origin policy or it was not called via a user interaction such as a button press.

Security

Transient user activation is required. The user has to interact with the page or a UI element in order for this feature to work.

Examples

This asynchronous function shows a directory picker and returns a FileSystemDirectoryHandle once selected.

async function getDir() {
  const dirHandle = await window.showDirectoryPicker();

  // run code for dirHandle
}

Specifications

Browser compatibility

See also