Back to Puppeteer

FileChooser class

docs/api/puppeteer.filechooser.md

19.2.21.9 KB
Original Source

FileChooser class

File choosers let you react to the page requesting for a file.

Signature

typescript
export declare class FileChooser

Remarks

FileChooser instances are returned via the Page.waitForFileChooser() method.

In browsers, only one file chooser can be opened at a time. All file choosers must be accepted or canceled. Not doing so will prevent subsequent file choosers from appearing.

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the FileChooser class.

Example

ts
const [fileChooser] = await Promise.all([
  page.waitForFileChooser(),
  page.click('#upload-file-button'), // some button that triggers file selection
]);
await fileChooser.accept(['/tmp/myfile.pdf']);

Methods

<table><thead><tr><th>

Method

</th><th>

Modifiers

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

<span id="accept">accept(paths)</span>

</td><td> </td><td>

Accept the file chooser request with the given file paths.

Remarks:

This will not validate whether the file paths exists. Also, if a path is relative, then it is resolved against the current working directory. For locals script connecting to remote chrome environments, paths must be absolute.

</td></tr> <tr><td>

<span id="cancel">cancel()</span>

</td><td> </td><td>

Closes the file chooser without selecting any files.

</td></tr> <tr><td>

<span id="ismultiple">isMultiple()</span>

</td><td> </td><td>

Whether file chooser allow for multiple file selection.

</td></tr> </tbody></table>