Draft
This page is not complete.
Secure context
This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The showOpenFilePicker()
method of the
Window
interface shows a file picker that allows a user to select a file
or multiple files and returns a handle for the file(s).
Syntax
var FileSystemHandles = Window.showOpenFilePicker();
Parameters
- options Optional
- An optional object containing options, which are as follows:
multiple
: ABoolean
. Defaultfalse
. When set totrue
multiple files may be selected.excludeAcceptAllOption
:ABoolean
. Defaultfalse
. By default the picker should include an option to not apply any file type filters (instigated with the type option below). Setting this option totrue
means that option is not available.types
: AnArray
of allowed file types to pick. Each item is an object with the following options:
Return value
A Array
of FileSystemFileHandle
objects.
Exceptions
AbortError
- An AbortError is thrown if a user dismisses the prompt without making a selection or if a file selected is deemed too sensitive or dangerous to be exposed to the website.
Examples
Here we set the options object for passing into the method. We'll allow a selection of image file types, with no option to allow for all files types, or multiple file selection.
const pickerOpts = {
types: [
{
description: 'Images',
accept: {
'image/*': ['.png', '.gif', '.jpeg', '.jpg']
}
},
],
excludeAcceptAllOption: true,
multiple: false
};
Next we can create an asynchronous function which show the file picker and return the selected file.
// create a reference for our file handle
let fileHandle;
async function getFile() {
// open file picker, destructure the one element returned array
[fileHandle] = await window.showOpenFilePicker(pickerOpts);
// run code with our fileHandle
}
Specifications
Specification | Status | Comment |
---|---|---|
Unknown The definition of 'showOpenFilePicker' in that specification. |
Unknown | Initial definition. |
Browser compatibility
BCD tables only load in the browser