Window.showDirectoryPicker()

安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

Window インターフェイスの showDirectoryPicker() メソッドは、ユーザーがディレクトリーを選択できるディレクトリーピッカーを表示します。

構文

showDirectoryPicker()

引数

options 省略可

以下のオプションを含むオブジェクトです。

id

ID を指定することで、ブラウザーは ID ごとに異なるディレクトリーを記憶することができます。他のピッカーで同じ ID を用いると、同じディレクトリーでピッカーが開きます。

mode

文字列です。ディレクトリーへの読み取り専用アクセスを表す "read" または、読み書きアクセスを表す "readwrite" を指定します。デフォルトは "read" です。

startIn

ダイアログを開く場所を指定する FileSystemHandle またはウェルノウンディレクトリー ("desktop"、"documents"、"downloads"、"music"、"pictures"、"videos" のいずれか) です。

返値

FileSystemDirectoryHandle で解決する Promise を返します。

例外

AbortError

ユーザーが選択せずにプロンプトを閉じた場合や、選択されたものをユーザーエージェントがセンシティブや危険だとみなした場合、投げられます。

セキュリティ

ユーザーによる一時的な有効化が必要です。この機能が動作するためには、ユーザーがページまたは UI 要素を操作することが必要です。

例

この非同期関数は、ディレクトリーピッカーを表示し、選択されたら FileSystemDirectoryHandle を返します。

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

  // dirHandle を扱うコードを実行する
}

仕様書

Specification
File System Access
# api-showdirectorypicker

ブラウザーの互換性

BCD tables only load in the browser

関連情報