webkitdirectoryでinputからフォルダを選択する
webkitdirectory属性を付けると、input type="file"でファイルの代わりにフォルダを選ばせ、サブフォルダの中のファイルまで受け取れます。webkitRelativePathで各ファイルの相対パスも分かります。
- Chrome13
- Edge13
- Firefox50
- Safari11.1
はじめに
webkitdirectoryは、<input type="file">でファイルの代わりにフォルダ(ディレクトリ)を選ばせる属性です。選んだフォルダの中のファイルがサブフォルダの中までfilesに入り、各ファイルのwebkitRelativePathには、選んだフォルダの名前から始まるパスが入ります。Firefox Androidが対応して、Baseline 2025に入りました。
ファイルを1つ、またはmultipleで複数選ばせるのは、type="file"でできます。<input>でフォルダを丸ごと選ばせて、どのファイルがどのサブフォルダにあったかまで受け取るのは、webkitdirectoryでしかできません。
<!-- ディレクトリ選択 -->
<input type="file" webkitdirectory />ボタンを押すと、ファイルではなくフォルダを選ぶダイアログが開きます。フォルダを選ぶと、中のファイルがまとめてfilesに入ります。
webkitdirectory属性
webkitdirectoryは真偽値の属性で、付けるとディレクトリの選択になり、付けなければファイルの選択になります。
値は見ないので、webkitdirectory="false"と書いてもディレクトリの選択になります。JavaScriptから切り替えるときは、プロパティにtrueかfalseを入れると属性が付け外しされます。
ファイルの取得
webkitdirectory属性を付けた<input>要素で選んだファイルも、multiple属性を付けたときと同じくfilesプロパティから取り出します。
filesプロパティはFileListオブジェクトまたはnullを返します。
FileListオブジェクトはFileオブジェクトの集合体で、Fileは添え字からのアクセスとitem()メソッドでアクセスできます。また、FileListはイテレーターとしての機能も持っています。
const files = inputElement.files;
// 選択されたファイル数
console.log(files?.length);
// 添え字でのアクセス
console.log(files?.[0]);
// item()メソッドでのアクセス なければnullを返す
console.log(files?.item(0));
// イテレーターでのアクセス
for (const file of files ?? []) {
console.log(file);
}webkitdirectory属性を付与した<input>要素から入力されたFileは書き換え不可なwebkitRelativePathプロパティを持ちます。
このプロパティには、選択されたファイルの相対パスが格納されます。
const files = inputElement.files;
for (const file of files ?? []) {
console.log(file.webkitRelativePath);
}Chromeで、a.txtと.hiddenのほかにサブフォルダと空のフォルダを置いたphotosフォルダを選ぶと、上のコードは次の4行を出しました。
photos/.hidden
photos/a.txt
photos/sub/b.txt
photos/sub/deeper/c.txtパスは選んだフォルダの名前から始まり、.で始まるファイルも入りますが、空のフォルダ(photos/empty)は入りません。multiple属性を付けなくても、サブフォルダの中のファイルまで入ります。そのままフォームで送ると、multipartのfilenameにもphotos/sub/b.txtのようなパスが入ります。
テストでDataTransferを使ってfilesにFileを入れても、webkitRelativePathは空文字のままです。webkitRelativePathを使う処理をテストするときは、PlaywrightのsetInputFiles()にフォルダのパスを渡して、ブラウザにフォルダを選ばせます。
下記の例では渡したディレクトリに含まれるファイルのwebkitRelativePathプロパティを表示しています。
<form>
<label>
ディレクトリ選択
<input type="file" id="directory" webkitdirectory />
</label>
<button type="reset">すべて解除</button>
</form>
<ul id="paths"></ul>const input = document.getElementById('directory');
const paths = document.getElementById('paths');
input.addEventListener('change', () => {
const items = Array.from(input.files, (file) => {
const item = document.createElement('li');
item.textContent = file.webkitRelativePath;
return item;
});
paths.replaceChildren(...items);
});
input.form.addEventListener('reset', () => {
paths.replaceChildren();
});ボタンを押してフォルダを選ぶと、中の各ファイルがwebkitRelativePathのパスと一緒に一覧になります。
input要素で複数のファイルを扱う別の方法にwebkitEntriesプロパティがありますが、Chromeではwebkitdirectory属性を付けるとwebkitEntriesが空の配列になります。
INTEROP: In Chrome, if webkitdirectory is specified on a HTMLInputElement, webkitEntries is not populated; the files collection and webkitRelativePath properties must be used instead to reconstruct the directory structure. Should we fix this so it is always populated?
AIによる翻訳: Chromeにおいて、HTMLInputElementにwebkitdirectoryが指定されている場合、webkitEntriesは設定されません。代わりに、filesコレクションとwebkitRelativePathプロパティを使用してディレクトリ構造を再構築する必要があります。これを常に設定されるように修正すべきでしょうか?
おわりに
input要素でファイルを扱う際に、webkitdirectory属性を利用することでディレクトリごと選択可能になり、中のファイルをwebkitRelativePathのパスと一緒に受け取れるようになりました。
webkitdirectory属性のようなwebkitprefixがついている機能は利用を躊躇いますが、Baseline 2025に追加されたことで安心して利用できるようになったのではないでしょうか。