afc75884d7
**What kind of change does this PR introduce?** Typo fix in the documentation **Did you add tests for your changes?** No **If relevant, did you update the documentation?** N/A **Summary** I spotted the `Visible` parameter had an uppercase `V` in the [Remarks section of the Page.waitForSelector API documentation](https://pptr.dev/api/puppeteer.page.waitforselector#remarks). Updated this to the lowercase `v` in the relevant places (source, documentation, versioned version of the doc page). While doing this, I also spotted there was an extra space in `are :` in the sentence above – so changed that as well. **Does this PR introduce a breaking change?** No **Other information** I’ve confirmed the parameter is spelled correctly on https://pptr.dev/api/puppeteer.waitforselectoroptions. I’m not sure why the documentation for those properties is in two places with slightly different wording – but to me it felt useful to see this directly on the method’s API docs.
2.7 KiB
| sidebar_label |
|---|
| Page.waitForSelector |
Page.waitForSelector() method
Wait for the selector to appear in page. If at the moment of calling the method the selector already exists, the method will return immediately. If the selector doesn't appear after the timeout milliseconds of waiting, the function will throw.
This method works across navigations:
const puppeteer = require('puppeteer');
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
let currentURL;
page
.waitForSelector('img')
.then(() => console.log('First URL with image: ' + currentURL));
for (currentURL of [
'https://example.com',
'https://google.com',
'https://bbc.com',
]) {
await page.goto(currentURL);
}
await browser.close();
})();
Signature:
class Page {
waitForSelector<Selector extends string>(
selector: Selector,
options?: WaitForSelectorOptions
): Promise<ElementHandle<NodeFor<Selector>> | null>;
}
Parameters
| Parameter | Type | Description |
|---|---|---|
| selector | Selector | A selector of an element to wait for |
| options | WaitForSelectorOptions | (Optional) Optional waiting parameters |
Returns:
Promise<ElementHandle<NodeFor<Selector>> | null>
Promise which resolves when element specified by selector string is added to DOM. Resolves to null if waiting for hidden: true and selector is not found in DOM.
Remarks
The optional Parameter in Arguments options are:
-
visible: A boolean wait for element to be present in DOM and to be visible, i.e. to not havedisplay: noneorvisibility: hiddenCSS properties. Defaults tofalse. -
hidden: Wait for element to not be found in the DOM or to be hidden, i.e. havedisplay: noneorvisibility: hiddenCSS properties. Defaults tofalse. -
timeout: maximum time to wait for in milliseconds. Defaults to30000(30 seconds). Pass0to disable timeout. The default value can be changed by using the Page.setDefaultTimeout() method.