puppeteer/docs/api/puppeteer.page.click.md

77 lines
1.6 KiB
Markdown
Raw Normal View History

2022-07-05 13:41:43 +00:00
---
sidebar_label: Page.click
---
# Page.click() method
This method fetches an element with `selector`, scrolls it into view if needed, and then uses [Page.mouse](./puppeteer.page.md#mouse) to click in the center of the element. If there's no element matching `selector`, the method throws an error.
2022-07-05 13:41:43 +00:00
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
class Page {
2023-04-25 11:28:47 +00:00
click(selector: string, options?: Readonly<ClickOptions>): Promise<void>;
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>
selector
</td><td>
string
</td><td>
A `selector` to search for element to click. If there are multiple elements satisfying the `selector`, the first will be clicked
</td></tr>
<tr><td>
options
</td><td>
Readonly&lt;[ClickOptions](./puppeteer.clickoptions.md)&gt;
</td><td>
_(Optional)_ `Object`
</td></tr>
</tbody></table>
2022-07-05 13:41:43 +00:00
**Returns:**
Promise&lt;void&gt;
Promise which resolves when the element matching `selector` is successfully clicked. The Promise will be rejected if there is no element matching `selector`.
## Remarks
Bear in mind that if `click()` triggers a navigation event and there's a separate `page.waitForNavigation()` promise to be resolved, you may end up with a race condition that yields unexpected results. The correct pattern for click and wait for navigation is the following:
```ts
const [response] = await Promise.all([
page.waitForNavigation(waitOptions),
page.click(selector, clickOptions),
]);
```
Shortcut for [page.mainFrame().click(selector\[, options\])](./puppeteer.frame.click.md).