Back to Puppeteer

Page.waitForFileChooser() method

website/versioned_docs/version-24.40.0/api/puppeteer.page.waitforfilechooser.md

19.2.21.3 KB
Original Source

Page.waitForFileChooser() method

This method is typically coupled with an action that triggers file choosing.

:::caution

This must be called before the file chooser is launched. It will not return a currently active file chooser.

:::

:::caution

Interception of file dialogs triggered via DOM APIs such as window.showOpenFilePicker is currently not supported.

:::

Signature

typescript
class Page {
  abstract waitForFileChooser(
    options?: WaitTimeoutOptions,
  ): Promise<FileChooser>;
}

Parameters

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

Parameter

</th><th>

Type

</th><th>

Description

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

options

</td><td>

WaitTimeoutOptions

</td><td>

(Optional)

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

Returns:

Promise<FileChooser>

Remarks

In the "headful" browser, this method results in the native file picker dialog not showing up for the user.

Example

The following example clicks a button that issues a file chooser and then responds with /tmp/myfile.pdf as if a user has selected this file.

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']);