pageFunction. |
**Returns:**
Promise<Awaited<ReturnType<Func>>>
-## Example 1
+A promise to the result of the function.
+
+## Example
+
+HTML:
```html
pageFunction. |
**Returns:**
Promise<Awaited<ReturnType<Func>>>
+A promise to the result of the function.
+
## Example
```ts
diff --git a/docs/api/puppeteer.elementhandle.md b/docs/api/puppeteer.elementhandle.md
index e741b62b..1a0b95bd 100644
--- a/docs/api/puppeteer.elementhandle.md
+++ b/docs/api/puppeteer.elementhandle.md
@@ -41,32 +41,32 @@ The constructor for this class is marked as internal. Third-party code should no
## Methods
-| Method | Modifiers | Description |
-| -------------------------------------------------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [$(selector)](./puppeteer.elementhandle._.md) | | Runs element.querySelector within the page. |
-| [$$(selector)](./puppeteer.elementhandle.__.md) | | Runs element.querySelectorAll within the page. |
-| [$$eval(selector, pageFunction, args)](./puppeteer.elementhandle.__eval.md) | | This method runs document.querySelectorAll within the element and passes it as the first argument to pageFunction. If there's no element matching selector, the method throws an error.
If pageFunction returns a Promise, then frame.$$eval would wait for the promise to resolve and return its value.
This method runs document.querySelector within the element and passes it as the first argument to pageFunction. If there's no element matching selector, the method throws an error.
If pageFunction returns a Promise, then frame.$eval would wait for the promise to resolve and return its value.
null if the element is not visible. |
-| [boxModel()](./puppeteer.elementhandle.boxmodel.md) | | This method returns boxes of the element, or null if the element is not visible. |
-| [click(this, options)](./puppeteer.elementhandle.click.md) | | This method scrolls element into view if needed, and then uses [Page.mouse](./puppeteer.page.mouse.md) to click in the center of the element. If the element is detached from DOM, the method throws an error. |
-| [clickablePoint(offset)](./puppeteer.elementhandle.clickablepoint.md) | | Returns the middle point within an element unless a specific offset is provided. |
-| [contentFrame()](./puppeteer.elementhandle.contentframe.md) | | Resolves to the content frame for element handles referencing iframe nodes, or null otherwise |
-| [drag(this, target)](./puppeteer.elementhandle.drag.md) | | This method creates and captures a dragevent from the element. |
-| [dragAndDrop(this, target, options)](./puppeteer.elementhandle.draganddrop.md) | | This method triggers a dragenter, dragover, and drop on the element. |
-| [dragEnter(this, data)](./puppeteer.elementhandle.dragenter.md) | | This method creates a dragenter event on the element. |
-| [dragOver(this, data)](./puppeteer.elementhandle.dragover.md) | | This method creates a dragover event on the element. |
-| [drop(this, data)](./puppeteer.elementhandle.drop.md) | | This method triggers a drop on the element. |
-| [focus()](./puppeteer.elementhandle.focus.md) | | Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element. |
-| [hover(this)](./puppeteer.elementhandle.hover.md) | | This method scrolls element into view if needed, and then uses [Page.mouse](./puppeteer.page.mouse.md) to hover over the center of the element. If the element is detached from DOM, the method throws an error. |
-| [isIntersectingViewport(this, options)](./puppeteer.elementhandle.isintersectingviewport.md) | | Resolves to true if the element is visible in the current viewport. |
-| [press(key, options)](./puppeteer.elementhandle.press.md) | | Focuses the element, and then uses [Keyboard.down()](./puppeteer.keyboard.down.md) and [Keyboard.up()](./puppeteer.keyboard.up.md). |
-| [screenshot(this, options)](./puppeteer.elementhandle.screenshot.md) | | This method scrolls element into view if needed, and then uses [Page.screenshot()](./puppeteer.page.screenshot.md) to take a screenshot of the element. If the element is detached from DOM, the method throws an error. |
-| [select(values)](./puppeteer.elementhandle.select.md) | | Triggers a change and input event once all the provided options have been selected. If there's no <select> element matching selector, the method throws an error. |
-| [tap(this)](./puppeteer.elementhandle.tap.md) | | This method scrolls element into view if needed, and then uses [Touchscreen.tap()](./puppeteer.touchscreen.tap.md) to tap in the center of the element. If the element is detached from DOM, the method throws an error. |
-| [type(text, options)](./puppeteer.elementhandle.type.md) | | Focuses the element, and then sends a keydown, keypress/input, and keyup event for each character in the text.
To press a special key, like Control or ArrowDown, use [ElementHandle.press()](./puppeteer.elementhandle.press.md).
elementHandle to point to an [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). |
-| [waitForSelector(selector, options)](./puppeteer.elementhandle.waitforselector.md) | | Wait for the selector to appear within the element. 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 does not work across navigations or if the element is detached from DOM.
| -| [waitForXPath(xpath, options)](./puppeteer.elementhandle.waitforxpath.md) | | | +| Method | Modifiers | Description | +| -------------------------------------------------------------------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [$(selector)](./puppeteer.elementhandle._.md) | | Queries the current element for an element matching the given selector. | +| [$$(selector)](./puppeteer.elementhandle.__.md) | | Queries the current element for all elements matching the given selector. | +| [$$eval(selector, pageFunction, args)](./puppeteer.elementhandle.__eval.md) | |Runs the given function on an array of elements matching the given selector in the current element.
If the given function returns a promise, then this method will wait till the promise resolves.
| +| [$eval(selector, pageFunction, args)](./puppeteer.elementhandle._eval.md) | |Runs the given function on the first element matching the given selector in the current element.
If the given function returns a promise, then this method will wait till the promise resolves.
| +| [$x(expression)](./puppeteer.elementhandle._x.md) | | | +| [asElement()](./puppeteer.elementhandle.aselement.md) | | | +| [boundingBox()](./puppeteer.elementhandle.boundingbox.md) | | This method returns the bounding box of the element (relative to the main frame), ornull if the element is not visible. |
+| [boxModel()](./puppeteer.elementhandle.boxmodel.md) | | This method returns boxes of the element, or null if the element is not visible. |
+| [click(this, options)](./puppeteer.elementhandle.click.md) | | This method scrolls element into view if needed, and then uses [Page.mouse](./puppeteer.page.mouse.md) to click in the center of the element. If the element is detached from DOM, the method throws an error. |
+| [clickablePoint(offset)](./puppeteer.elementhandle.clickablepoint.md) | | Returns the middle point within an element unless a specific offset is provided. |
+| [contentFrame()](./puppeteer.elementhandle.contentframe.md) | | Resolves to the content frame for element handles referencing iframe nodes, or null otherwise |
+| [drag(this, target)](./puppeteer.elementhandle.drag.md) | | This method creates and captures a dragevent from the element. |
+| [dragAndDrop(this, target, options)](./puppeteer.elementhandle.draganddrop.md) | | This method triggers a dragenter, dragover, and drop on the element. |
+| [dragEnter(this, data)](./puppeteer.elementhandle.dragenter.md) | | This method creates a dragenter event on the element. |
+| [dragOver(this, data)](./puppeteer.elementhandle.dragover.md) | | This method creates a dragover event on the element. |
+| [drop(this, data)](./puppeteer.elementhandle.drop.md) | | This method triggers a drop on the element. |
+| [focus()](./puppeteer.elementhandle.focus.md) | | Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element. |
+| [hover(this)](./puppeteer.elementhandle.hover.md) | | This method scrolls element into view if needed, and then uses [Page.mouse](./puppeteer.page.mouse.md) to hover over the center of the element. If the element is detached from DOM, the method throws an error. |
+| [isIntersectingViewport(this, options)](./puppeteer.elementhandle.isintersectingviewport.md) | | Resolves to true if the element is visible in the current viewport. |
+| [press(key, options)](./puppeteer.elementhandle.press.md) | | Focuses the element, and then uses [Keyboard.down()](./puppeteer.keyboard.down.md) and [Keyboard.up()](./puppeteer.keyboard.up.md). |
+| [screenshot(this, options)](./puppeteer.elementhandle.screenshot.md) | | This method scrolls element into view if needed, and then uses [Page.screenshot()](./puppeteer.page.screenshot.md) to take a screenshot of the element. If the element is detached from DOM, the method throws an error. |
+| [select(values)](./puppeteer.elementhandle.select.md) | | Triggers a change and input event once all the provided options have been selected. If there's no <select> element matching selector, the method throws an error. |
+| [tap(this)](./puppeteer.elementhandle.tap.md) | | This method scrolls element into view if needed, and then uses [Touchscreen.tap()](./puppeteer.touchscreen.tap.md) to tap in the center of the element. If the element is detached from DOM, the method throws an error. |
+| [type(text, options)](./puppeteer.elementhandle.type.md) | | Focuses the element, and then sends a keydown, keypress/input, and keyup event for each character in the text.
To press a special key, like Control or ArrowDown, use [ElementHandle.press()](./puppeteer.elementhandle.press.md).
elementHandle to point to an [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). |
+| [waitForSelector(selector, options)](./puppeteer.elementhandle.waitforselector.md) | | Wait for an element matching the given selector to appear in the current element.
Unlike [Frame.waitForSelector()](./puppeteer.frame.waitforselector.md), this method does not work across navigations or if the element is detached from DOM.
| +| [waitForXPath(xpath, options)](./puppeteer.elementhandle.waitforxpath.md) | | | diff --git a/docs/api/puppeteer.elementhandle.waitforselector.md b/docs/api/puppeteer.elementhandle.waitforselector.md index 22617c4b..5f905d17 100644 --- a/docs/api/puppeteer.elementhandle.waitforselector.md +++ b/docs/api/puppeteer.elementhandle.waitforselector.md @@ -4,9 +4,9 @@ sidebar_label: ElementHandle.waitForSelector # ElementHandle.waitForSelector() method -Wait for the `selector` to appear within the element. 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. +Wait for an element matching the given selector to appear in the current element. -This method does not work across navigations or if the element is detached from DOM. +Unlike [Frame.waitForSelector()](./puppeteer.frame.waitforselector.md), this method does not work across navigations or if the element is detached from DOM. **Signature:** @@ -21,23 +21,42 @@ class ElementHandle { ## Parameters -| Parameter | Type | Description | -| --------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| selector | Selector | A [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors) of an element to wait for | -| options | Exclude<[WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md), 'root'> | (Optional) Optional waiting parameters | +| Parameter | Type | Description | +| --------- | -------------------------------------------------------------------------------------- | ----------------------------------------------------------- | +| selector | Selector | The selector to query and wait for. | +| options | Exclude<[WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md), 'root'> | (Optional) Options for customizing waiting behavior. | **Returns:** Promise<[ElementHandle](./puppeteer.elementhandle.md)<[NodeFor](./puppeteer.nodefor.md)<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. +An element matching the given selector. -## Remarks +## Exceptions -The optional parameters in `options` are: +Throws if an element matching the given selector doesn't appear. -- `visible`: wait for the selected element to be present in DOM and to be visible, i.e. to not have `display: none` or `visibility: hidden` CSS properties. Defaults to `false`. +## Example -- `hidden`: wait for the selected element to not be found in the DOM or to be hidden, i.e. have `display: none` or `visibility: hidden` CSS properties. Defaults to `false`. +```ts +const puppeteer = require('puppeteer'); -- `timeout`: maximum time to wait in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [Page.setDefaultTimeout()](./puppeteer.page.setdefaulttimeout.md) method. +(async () => { + const browser = await puppeteer.launch(); + const page = await browser.newPage(); + let currentURL; + page + .mainFrame() + .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(); +})(); +``` diff --git a/docs/api/puppeteer.filechooser.md b/docs/api/puppeteer.filechooser.md index 8eaae182..589056b1 100644 --- a/docs/api/puppeteer.filechooser.md +++ b/docs/api/puppeteer.filechooser.md @@ -14,14 +14,14 @@ export declare class FileChooser ## Remarks -`FileChooser` objects are returned via the `page.waitForFileChooser` method. +`FileChooser` instances are returned via the [Page.waitForFileChooser()](./puppeteer.page.waitforfilechooser.md) 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 -An example of using `FileChooser`: - ```ts const [fileChooser] = await Promise.all([ page.waitForFileChooser(), @@ -30,8 +30,6 @@ const [fileChooser] = await Promise.all([ await fileChooser.accept(['/tmp/myfile.pdf']); ``` -\*\*NOTE\*\* 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. - ## Methods | Method | Modifiers | Description | diff --git a/docs/api/puppeteer.frame._.md b/docs/api/puppeteer.frame._.md index 1e29bcb8..d9f5cb88 100644 --- a/docs/api/puppeteer.frame._.md +++ b/docs/api/puppeteer.frame._.md @@ -4,7 +4,7 @@ sidebar_label: Frame.$ # Frame.$() method -This method queries the frame for the given selector. +Queries the frame for an element matching the given selector. **Signature:** @@ -18,12 +18,12 @@ class Frame { ## Parameters -| Parameter | Type | Description | -| --------- | -------- | ------------------------ | -| selector | Selector | a selector to query for. | +| Parameter | Type | Description | +| --------- | -------- | -------------------------- | +| selector | Selector | The selector to query for. | **Returns:** Promise<[ElementHandle](./puppeteer.elementhandle.md)<[NodeFor](./puppeteer.nodefor.md)<Selector>> \| null> -A promise which resolves to an `ElementHandle` pointing at the element, or `null` if it was not found. +A [element handle](./puppeteer.elementhandle.md) to the first element matching the given selector. Otherwise, `null`. diff --git a/docs/api/puppeteer.frame.__.md b/docs/api/puppeteer.frame.__.md index 7b296cbd..66cc1899 100644 --- a/docs/api/puppeteer.frame.__.md +++ b/docs/api/puppeteer.frame.__.md @@ -4,7 +4,7 @@ sidebar_label: Frame.$$ # Frame.$$() method -This runs `document.querySelectorAll` in the frame and returns the result. +Queries the frame for all elements matching the given selector. **Signature:** @@ -18,12 +18,12 @@ class Frame { ## Parameters -| Parameter | Type | Description | -| --------- | -------- | ------------------------ | -| selector | Selector | a selector to search for | +| Parameter | Type | Description | +| --------- | -------- | -------------------------- | +| selector | Selector | The selector to query for. | **Returns:** Promise<Array<[ElementHandle](./puppeteer.elementhandle.md)<[NodeFor](./puppeteer.nodefor.md)<Selector>>>> -An array of element handles pointing to the found frame elements. +An array of [element handles](./puppeteer.elementhandle.md) that point to elements matching the given selector. diff --git a/docs/api/puppeteer.frame.__eval.md b/docs/api/puppeteer.frame.__eval.md index 6db54e4e..2007e355 100644 --- a/docs/api/puppeteer.frame.__eval.md +++ b/docs/api/puppeteer.frame.__eval.md @@ -4,6 +4,10 @@ sidebar_label: Frame.$$eval # Frame.$$eval() method +Runs the given function on an array of elements matching the given selector in the frame. + +If the given function returns a promise, then this method will wait till the promise resolves. + **Signature:** ```typescript @@ -24,24 +28,20 @@ class Frame { ## Parameters -| Parameter | Type | Description | -| ------------ | -------------- | --------------------------------------------------------- | -| selector | Selector | the selector to query for | -| pageFunction | Func \| string | the function to be evaluated in the frame's context | -| args | Params | additional arguments to pass topageFunction |
+| Parameter | Type | Description |
+| ------------ | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| selector | Selector | The selector to query for. |
+| pageFunction | Func \| string | The function to be evaluated in the frame's context. An array of elements matching the given selector will be passed to the function as its first argument. |
+| args | Params | Additional arguments to pass to pageFunction. |
**Returns:**
Promise<Awaited<ReturnType<Func>>>
-## Remarks
-
-This method runs `Array.from(document.querySelectorAll(selector))` within the frame and passes it as the first argument to `pageFunction`.
-
-If `pageFunction` returns a Promise, then `frame.$$eval` would wait for the promise to resolve and return its value.
+A promise to the result of the function.
## Example
-```ts
+```js
const divsCounts = await frame.$$eval('div', divs => divs.length);
```
diff --git a/docs/api/puppeteer.frame._eval.md b/docs/api/puppeteer.frame._eval.md
index 28ead092..0c6589a1 100644
--- a/docs/api/puppeteer.frame._eval.md
+++ b/docs/api/puppeteer.frame._eval.md
@@ -4,6 +4,10 @@ sidebar_label: Frame.$eval
# Frame.$eval() method
+Runs the given function on the first element matching the given selector in the frame.
+
+If the given function returns a promise, then this method will wait till the promise resolves.
+
**Signature:**
```typescript
@@ -24,21 +28,17 @@ class Frame {
## Parameters
-| Parameter | Type | Description |
-| ------------ | -------------- | --------------------------------------------------------- |
-| selector | Selector | the selector to query for |
-| pageFunction | Func \| string | the function to be evaluated in the frame's context |
-| args | Params | additional arguments to pass to pageFunction |
+| Parameter | Type | Description |
+| ------------ | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| selector | Selector | The selector to query for. |
+| pageFunction | Func \| string | The function to be evaluated in the frame's context. The first element matching the selector will be passed to the function as its first argument. |
+| args | Params | Additional arguments to pass to pageFunction. |
**Returns:**
Promise<Awaited<ReturnType<Func>>>
-## Remarks
-
-This method runs `document.querySelector` within the frame and passes it as the first argument to `pageFunction`.
-
-If `pageFunction` returns a Promise, then `frame.$eval` would wait for the promise to resolve and return its value.
+A promise to the result of the function.
## Example
diff --git a/docs/api/puppeteer.frame._x.md b/docs/api/puppeteer.frame._x.md
index e2290048..dd7a17b4 100644
--- a/docs/api/puppeteer.frame._x.md
+++ b/docs/api/puppeteer.frame._x.md
@@ -4,7 +4,11 @@ sidebar_label: Frame.$x
# Frame.$x() method
-This method evaluates the given XPath expression and returns the results.
+> Warning: This API is now obsolete.
+>
+> Use [Frame.$$()](./puppeteer.frame.__.md) with the `xpath` prefix.
+>
+> This method evaluates the given XPath expression and returns the results.
**Signature:**
diff --git a/docs/api/puppeteer.frame.addscripttag.md b/docs/api/puppeteer.frame.addscripttag.md
index 3baf564e..67e26385 100644
--- a/docs/api/puppeteer.frame.addscripttag.md
+++ b/docs/api/puppeteer.frame.addscripttag.md
@@ -18,9 +18,9 @@ class Frame {
## Parameters
-| Parameter | Type | Description |
-| --------- | ------------------------------------------------------------------- | ---------------------------------------- |
-| options | [FrameAddScriptTagOptions](./puppeteer.frameaddscripttagoptions.md) | configure the script to add to the page. |
+| Parameter | Type | Description |
+| --------- | ------------------------------------------------------------------- | ----------------------- |
+| options | [FrameAddScriptTagOptions](./puppeteer.frameaddscripttagoptions.md) | Options for the script. |
**Returns:**
diff --git a/docs/api/puppeteer.frame.addstyletag.md b/docs/api/puppeteer.frame.addstyletag.md
index e5a13076..5b00d734 100644
--- a/docs/api/puppeteer.frame.addstyletag.md
+++ b/docs/api/puppeteer.frame.addstyletag.md
@@ -10,18 +10,20 @@ Adds a `` tag into the page with the desired url or a `document.querySelectorAll in the frame and returns the result. |
-| [$$eval(selector, pageFunction, args)](./puppeteer.frame.__eval.md) | | |
-| [$eval(selector, pageFunction, args)](./puppeteer.frame._eval.md) | | |
-| [$x(expression)](./puppeteer.frame._x.md) | | This method evaluates the given XPath expression and returns the results. |
-| [addScriptTag(options)](./puppeteer.frame.addscripttag.md) | | Adds a <script> tag into the page with the desired url or content. |
-| [addStyleTag(options)](./puppeteer.frame.addstyletag.md) | | Adds a <link rel="stylesheet"> tag into the page with the desired url or a <style type="text/css"> tag with the content. |
-| [childFrames()](./puppeteer.frame.childframes.md) | | |
-| [click(selector, options)](./puppeteer.frame.click.md) | | This method clicks the first element found that matches selector. |
-| [content()](./puppeteer.frame.content.md) | | |
-| [evaluate(pageFunction, args)](./puppeteer.frame.evaluate.md) | | |
-| [evaluateHandle(pageFunction, args)](./puppeteer.frame.evaluatehandle.md) | | |
-| [executionContext()](./puppeteer.frame.executioncontext.md) | | |
-| [focus(selector)](./puppeteer.frame.focus.md) | | This method fetches an element with selector and focuses it. |
-| [goto(url, options)](./puppeteer.frame.goto.md) | | |
-| [hover(selector)](./puppeteer.frame.hover.md) | | This method fetches an element with selector, scrolls it into view if needed, and then uses [Page.mouse](./puppeteer.page.mouse.md) to hover over the center of the element. |
-| [isDetached()](./puppeteer.frame.isdetached.md) | | |
-| [isOOPFrame()](./puppeteer.frame.isoopframe.md) | | |
-| [name()](./puppeteer.frame.name.md) | | |
-| [page()](./puppeteer.frame.page.md) | | |
-| [parentFrame()](./puppeteer.frame.parentframe.md) | | |
-| [select(selector, values)](./puppeteer.frame.select.md) | | Triggers a change and input event once all the provided options have been selected. |
-| [setContent(html, options)](./puppeteer.frame.setcontent.md) | | Set the content of the frame. |
-| [tap(selector)](./puppeteer.frame.tap.md) | | This method fetches an element with selector, scrolls it into view if needed, and then uses [Page.touchscreen](./puppeteer.page.touchscreen.md) to tap in the center of the element. |
-| [title()](./puppeteer.frame.title.md) | | |
-| [type(selector, text, options)](./puppeteer.frame.type.md) | | Sends a keydown, keypress/input, and keyup event for each character in the text. |
-| [url()](./puppeteer.frame.url.md) | | |
-| [waitForFunction(pageFunction, options, args)](./puppeteer.frame.waitforfunction.md) | | |
-| [waitForNavigation(options)](./puppeteer.frame.waitfornavigation.md) | | |
-| [waitForSelector(selector, options)](./puppeteer.frame.waitforselector.md) | | |
-| [waitForTimeout(milliseconds)](./puppeteer.frame.waitfortimeout.md) | | Causes your script to wait for the given number of milliseconds. |
-| [waitForXPath(xpath, options)](./puppeteer.frame.waitforxpath.md) | | |
+| Method | Modifiers | Description |
+| ------------------------------------------------------------------------------------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [$(selector)](./puppeteer.frame._.md) | | Queries the frame for an element matching the given selector. |
+| [$$(selector)](./puppeteer.frame.__.md) | | Queries the frame for all elements matching the given selector. |
+| [$$eval(selector, pageFunction, args)](./puppeteer.frame.__eval.md) | | Runs the given function on an array of elements matching the given selector in the frame.
If the given function returns a promise, then this method will wait till the promise resolves.
| +| [$eval(selector, pageFunction, args)](./puppeteer.frame._eval.md) | |Runs the given function on the first element matching the given selector in the frame.
If the given function returns a promise, then this method will wait till the promise resolves.
| +| [$x(expression)](./puppeteer.frame._x.md) | | | +| [addScriptTag(options)](./puppeteer.frame.addscripttag.md) | | Adds a<script> tag into the page with the desired url or content. |
+| [addStyleTag(options)](./puppeteer.frame.addstyletag.md) | | Adds a <link rel="stylesheet"> tag into the page with the desired url or a <style type="text/css"> tag with the content. |
+| [childFrames()](./puppeteer.frame.childframes.md) | | |
+| [click(selector, options)](./puppeteer.frame.click.md) | | Clicks the first element found that matches selector. |
+| [content()](./puppeteer.frame.content.md) | | |
+| [evaluate(pageFunction, args)](./puppeteer.frame.evaluate.md) | | Behaves identically to [Page.evaluate()](./puppeteer.page.evaluate.md) except it's run within the the context of this frame. |
+| [evaluateHandle(pageFunction, args)](./puppeteer.frame.evaluatehandle.md) | | Behaves identically to [Page.evaluateHandle()](./puppeteer.page.evaluatehandle.md) except it's run within the context of this frame. |
+| [executionContext()](./puppeteer.frame.executioncontext.md) | | |
+| [focus(selector)](./puppeteer.frame.focus.md) | | Focuses the first element that matches the selector. |
+| [goto(url, options)](./puppeteer.frame.goto.md) | | Navigates a frame to the given url. |
+| [hover(selector)](./puppeteer.frame.hover.md) | | Hovers the pointer over the center of the first element that matches the selector. |
+| [isDetached()](./puppeteer.frame.isdetached.md) | | |
+| [isOOPFrame()](./puppeteer.frame.isoopframe.md) | | |
+| [name()](./puppeteer.frame.name.md) | | |
+| [page()](./puppeteer.frame.page.md) | | |
+| [parentFrame()](./puppeteer.frame.parentframe.md) | | |
+| [select(selector, values)](./puppeteer.frame.select.md) | | Selects a set of value on the first <select> element that matches the selector. |
+| [setContent(html, options)](./puppeteer.frame.setcontent.md) | | Set the content of the frame. |
+| [tap(selector)](./puppeteer.frame.tap.md) | | Taps the first element that matches the selector. |
+| [title()](./puppeteer.frame.title.md) | | |
+| [type(selector, text, options)](./puppeteer.frame.type.md) | | Sends a keydown, keypress/input, and keyup event for each character in the text. |
+| [url()](./puppeteer.frame.url.md) | | |
+| [waitForFunction(pageFunction, options, args)](./puppeteer.frame.waitforfunction.md) | | |
+| [waitForNavigation(options)](./puppeteer.frame.waitfornavigation.md) | | Waits for the frame to navigate. It is useful for when you run code which will indirectly cause the frame to navigate.
Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is considered a navigation.
| +| [waitForSelector(selector, options)](./puppeteer.frame.waitforselector.md) | |Wait for an element matching the given selector to appear in the frame.
This method works across navigations.
| +| [waitForTimeout(milliseconds)](./puppeteer.frame.waitfortimeout.md) | | Causes your script to wait for the given number of milliseconds. | +| [waitForXPath(xpath, options)](./puppeteer.frame.waitforxpath.md) | | | diff --git a/docs/api/puppeteer.frame.name.md b/docs/api/puppeteer.frame.name.md index cb6e657d..b21daba9 100644 --- a/docs/api/puppeteer.frame.name.md +++ b/docs/api/puppeteer.frame.name.md @@ -16,10 +16,8 @@ class Frame { string -the frame's `name` attribute as specified in the tag. +The frame's `name` attribute as specified in the tag. ## Remarks -If the name is empty, it returns the `id` attribute instead. - -Note: This value is calculated once when the frame is created, and will not update if the attribute is changed later. +This value is calculated once when the frame is created, and will not update if the attribute is changed later. diff --git a/docs/api/puppeteer.frame.page.md b/docs/api/puppeteer.frame.page.md index 201dd209..476b98c3 100644 --- a/docs/api/puppeteer.frame.page.md +++ b/docs/api/puppeteer.frame.page.md @@ -16,4 +16,4 @@ class Frame { [Page](./puppeteer.page.md) -a page associated with the frame. +The page associated with the frame. diff --git a/docs/api/puppeteer.frame.select.md b/docs/api/puppeteer.frame.select.md index 15216f07..804ddb79 100644 --- a/docs/api/puppeteer.frame.select.md +++ b/docs/api/puppeteer.frame.select.md @@ -4,7 +4,7 @@ sidebar_label: Frame.select # Frame.select() method -Triggers a `change` and `input` event once all the provided options have been selected. +Selects a set of value on the first `