puppeteer/docs/api/puppeteer.page.waitforfilechooser.md

80 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2022-07-05 13:41:43 +00:00
---
sidebar_label: Page.waitForFileChooser
---
# 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:
2022-07-05 13:41:43 +00:00
```typescript
class Page {
abstract waitForFileChooser(
options?: WaitTimeoutOptions
): Promise<FileChooser>;
2022-07-05 13:41:43 +00:00
}
```
## Parameters
<table><thead><tr><th>
2022-07-05 13:41:43 +00:00
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
options
</td><td>
[WaitTimeoutOptions](./puppeteer.waittimeoutoptions.md)
</td><td>
_(Optional)_
</td></tr>
</tbody></table>
2022-07-05 13:41:43 +00:00
**Returns:**
Promise&lt;[FileChooser](./puppeteer.filechooser.md)&gt;
## Remarks
In the "headful" browser, this method results in the native file picker dialog `not showing up` for the user.
2022-07-05 13:41:43 +00:00
## 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']);
```