NOTE Use locator-based page.locator(selector[, options]) instead. Read more about locators.
The method finds an element matching the specified selector in the ElementHandle's subtree. If no elements match
the selector, returns null.
A selector to query for.
Optional options: { Optional
NOTE Use locator-based page.locator(selector[, options]) instead. Read more about locators.
The method finds an element matching the specified selector in the ElementHandle's subtree. If no elements match
the selector, returns null.
A selector to query for.
Optional options: { Optional
NOTE Use locator-based page.locator(selector[, options]) instead. Read more about locators.
The method finds all elements matching the specified selector in the ElementHandles subtree. If no elements match
the selector, returns empty array.
A selector to query for.
NOTE Use locator-based page.locator(selector[, options]) instead. Read more about locators.
The method finds all elements matching the specified selector in the ElementHandles subtree. If no elements match
the selector, returns empty array.
A selector to query for.
NOTE In most cases, locator.evaluateAll(pageFunction[, arg]), other Locator helper methods and web-first assertions do a better job.
Returns the return value of pageFunction.
The method finds all elements matching the specified selector in the ElementHandle's subtree and passes an array
of matched elements as a first argument to pageFunction.
If pageFunction returns a [Promise], then
elementHandle.$$eval(selector, pageFunction[, arg])
would wait for the promise to resolve and return its value.
Usage
<div class="feed">
<div class="tweet">Hello!</div>
<div class="tweet">Hi!</div>
</div>
const feedHandle = await page.$('.feed');
expect(await feedHandle.$$eval('.tweet', nodes =>
nodes.map(n => n.innerText))).toEqual(['Hello!', 'Hi!'],
);
A selector to query for.
Function to be evaluated in the page context.
Optional argument to pass to pageFunction.
NOTE In most cases, locator.evaluateAll(pageFunction[, arg]), other Locator helper methods and web-first assertions do a better job.
Returns the return value of pageFunction.
The method finds all elements matching the specified selector in the ElementHandle's subtree and passes an array
of matched elements as a first argument to pageFunction.
If pageFunction returns a [Promise], then
elementHandle.$$eval(selector, pageFunction[, arg])
would wait for the promise to resolve and return its value.
Usage
<div class="feed">
<div class="tweet">Hello!</div>
<div class="tweet">Hi!</div>
</div>
const feedHandle = await page.$('.feed');
expect(await feedHandle.$$eval('.tweet', nodes =>
nodes.map(n => n.innerText))).toEqual(['Hello!', 'Hi!'],
);
A selector to query for.
Function to be evaluated in the page context.
Optional argument to pass to pageFunction.
NOTE In most cases, locator.evaluateAll(pageFunction[, arg]), other Locator helper methods and web-first assertions do a better job.
Returns the return value of pageFunction.
The method finds all elements matching the specified selector in the ElementHandle's subtree and passes an array
of matched elements as a first argument to pageFunction.
If pageFunction returns a [Promise], then
elementHandle.$$eval(selector, pageFunction[, arg])
would wait for the promise to resolve and return its value.
Usage
<div class="feed">
<div class="tweet">Hello!</div>
<div class="tweet">Hi!</div>
</div>
const feedHandle = await page.$('.feed');
expect(await feedHandle.$$eval('.tweet', nodes =>
nodes.map(n => n.innerText))).toEqual(['Hello!', 'Hi!'],
);
A selector to query for.
Function to be evaluated in the page context.
Optional arg: anyOptional argument to pass to pageFunction.
Optional NOTE In most cases, locator.evaluateAll(pageFunction[, arg]), other Locator helper methods and web-first assertions do a better job.
Returns the return value of pageFunction.
The method finds all elements matching the specified selector in the ElementHandle's subtree and passes an array
of matched elements as a first argument to pageFunction.
If pageFunction returns a [Promise], then
elementHandle.$$eval(selector, pageFunction[, arg])
would wait for the promise to resolve and return its value.
Usage
<div class="feed">
<div class="tweet">Hello!</div>
<div class="tweet">Hi!</div>
</div>
const feedHandle = await page.$('.feed');
expect(await feedHandle.$$eval('.tweet', nodes =>
nodes.map(n => n.innerText))).toEqual(['Hello!', 'Hi!'],
);
A selector to query for.
Function to be evaluated in the page context.
Optional arg: anyOptional argument to pass to pageFunction.
Optional NOTE This method does not wait for the element to pass actionability checks and therefore can lead to the flaky tests. Use locator.evaluate(pageFunction[, arg, options]), other Locator helper methods or web-first assertions instead.
Returns the return value of pageFunction.
The method finds an element matching the specified selector in the ElementHandles subtree and passes it as a
first argument to pageFunction. If no elements match the selector, the method throws an error.
If pageFunction returns a [Promise], then
elementHandle.$eval(selector, pageFunction[, arg])
would wait for the promise to resolve and return its value.
Usage
const tweetHandle = await page.$('.tweet');
expect(await tweetHandle.$eval('.like', node => node.innerText)).toBe('100');
expect(await tweetHandle.$eval('.retweets', node => node.innerText)).toBe('10');
A selector to query for.
Function to be evaluated in the page context.
Optional argument to pass to pageFunction.
NOTE This method does not wait for the element to pass actionability checks and therefore can lead to the flaky tests. Use locator.evaluate(pageFunction[, arg, options]), other Locator helper methods or web-first assertions instead.
Returns the return value of pageFunction.
The method finds an element matching the specified selector in the ElementHandles subtree and passes it as a
first argument to pageFunction. If no elements match the selector, the method throws an error.
If pageFunction returns a [Promise], then
elementHandle.$eval(selector, pageFunction[, arg])
would wait for the promise to resolve and return its value.
Usage
const tweetHandle = await page.$('.tweet');
expect(await tweetHandle.$eval('.like', node => node.innerText)).toBe('100');
expect(await tweetHandle.$eval('.retweets', node => node.innerText)).toBe('10');
A selector to query for.
Function to be evaluated in the page context.
Optional argument to pass to pageFunction.
NOTE This method does not wait for the element to pass actionability checks and therefore can lead to the flaky tests. Use locator.evaluate(pageFunction[, arg, options]), other Locator helper methods or web-first assertions instead.
Returns the return value of pageFunction.
The method finds an element matching the specified selector in the ElementHandles subtree and passes it as a
first argument to pageFunction. If no elements match the selector, the method throws an error.
If pageFunction returns a [Promise], then
elementHandle.$eval(selector, pageFunction[, arg])
would wait for the promise to resolve and return its value.
Usage
const tweetHandle = await page.$('.tweet');
expect(await tweetHandle.$eval('.like', node => node.innerText)).toBe('100');
expect(await tweetHandle.$eval('.retweets', node => node.innerText)).toBe('10');
A selector to query for.
Function to be evaluated in the page context.
Optional arg: anyOptional argument to pass to pageFunction.
Optional NOTE This method does not wait for the element to pass actionability checks and therefore can lead to the flaky tests. Use locator.evaluate(pageFunction[, arg, options]), other Locator helper methods or web-first assertions instead.
Returns the return value of pageFunction.
The method finds an element matching the specified selector in the ElementHandles subtree and passes it as a
first argument to pageFunction. If no elements match the selector, the method throws an error.
If pageFunction returns a [Promise], then
elementHandle.$eval(selector, pageFunction[, arg])
would wait for the promise to resolve and return its value.
Usage
const tweetHandle = await page.$('.tweet');
expect(await tweetHandle.$eval('.like', node => node.innerText)).toBe('100');
expect(await tweetHandle.$eval('.retweets', node => node.innerText)).toBe('10');
A selector to query for.
Function to be evaluated in the page context.
Optional arg: anyOptional argument to pass to pageFunction.
Optional Returns either null or the object handle itself, if the object handle is an instance of ElementHandle.
This method returns the bounding box of the element, or null if the element is not visible. The bounding box is
calculated relative to the main frame viewport - which is usually the same as the browser window.
Scrolling affects the returned bounding box, similarly to
Element.getBoundingClientRect.
That means x and/or y may be negative.
Elements from child frames return the bounding box relative to the main frame, unlike the Element.getBoundingClientRect.
Assuming the page is static, it is safe to use bounding box coordinates to perform input. For example, the following snippet should click the center of the element.
Usage
const box = await elementHandle.boundingBox();
await page.mouse.click(box.x + box.width / 2, box.y + box.height / 2);
NOTE Use locator-based locator.check([options]) instead. Read more about locators.
This method checks the element by performing the following steps:
force option is set.noWaitAfter option is set.If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional noActions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
navigating to inaccessible pages. Defaults to false.
Optional position?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
NOTE Use locator-based locator.click([options]) instead. Read more about locators.
This method clicks the element by performing the following steps:
force option is set.position.noWaitAfter option is set.If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Optional options: { Optional
Optional button?: "left" | "right" | "middle"Defaults to left.
Optional clickdefaults to 1. See [UIEvent.detail].
Optional delay?: numberTime to wait between mousedown and mouseup in milliseconds. Defaults to 0.
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[]Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.
Optional noActions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
navigating to inaccessible pages. Defaults to false.
Optional position?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
NOTE Use locator-based locator.dblclick([options]) instead. Read more about locators.
This method double clicks the element by performing the following steps:
force option is set.position.noWaitAfter option is set. Note that if
the first click of the dblclick() triggers a navigation event, this method will throw.If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
NOTE elementHandle.dblclick() dispatches two click events and a single dblclick event.
Optional options: { Optional
Optional button?: "left" | "right" | "middle"Defaults to left.
Optional delay?: numberTime to wait between mousedown and mouseup in milliseconds. Defaults to 0.
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[]Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.
Optional noActions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
navigating to inaccessible pages. Defaults to false.
Optional position?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
NOTE Use locator-based locator.dispatchEvent(type[, eventInit, options]) instead. Read more about locators.
The snippet below dispatches the click event on the element. Regardless of the visibility state of the element,
click is dispatched. This is equivalent to calling
element.click().
Usage
await elementHandle.dispatchEvent('click');
Under the hood, it creates an instance of an event based on the given type, initializes it with eventInit
properties and dispatches it on the element. Events are composed, cancelable and bubble by default.
Since eventInit is event-specific, please refer to the events documentation for the lists of initial properties:
You can also specify JSHandle as the property value if you want live objects to be passed into the event:
// Note you can only create DataTransfer in Chromium and Firefox
const dataTransfer = await page.evaluateHandle(() => new DataTransfer());
await elementHandle.dispatchEvent('dragstart', { dataTransfer });
DOM event type: "click", "dragstart", etc.
Optional eventInit: EvaluationArgumentOptional event-specific initialization properties.
Optional Returns the return value of pageFunction.
This method passes this handle as the first argument to pageFunction.
If pageFunction returns a [Promise], then handle.evaluate would wait for the promise to resolve and return its
value.
Usage
const tweetHandle = await page.$('.tweet .retweets');
expect(await tweetHandle.evaluate(node => node.innerText)).toBe('10 retweets');
Function to be evaluated in the page context.
Optional argument to pass to pageFunction.
Returns the return value of pageFunction.
This method passes this handle as the first argument to pageFunction.
If pageFunction returns a [Promise], then handle.evaluate would wait for the promise to resolve and return its
value.
Usage
const tweetHandle = await page.$('.tweet .retweets');
expect(await tweetHandle.evaluate(node => node.innerText)).toBe('10 retweets');
Function to be evaluated in the page context.
Optional arg: anyOptional argument to pass to pageFunction.
Optional Returns the return value of pageFunction as a JSHandle.
This method passes this handle as the first argument to pageFunction.
The only difference between jsHandle.evaluate and jsHandle.evaluateHandle is that jsHandle.evaluateHandle
returns JSHandle.
If the function passed to the jsHandle.evaluateHandle returns a [Promise], then jsHandle.evaluateHandle would
wait for the promise to resolve and return its value.
See page.evaluateHandle(pageFunction[, arg]) for more details.
Function to be evaluated in the page context.
Optional argument to pass to pageFunction.
Returns the return value of pageFunction as a JSHandle.
This method passes this handle as the first argument to pageFunction.
The only difference between jsHandle.evaluate and jsHandle.evaluateHandle is that jsHandle.evaluateHandle
returns JSHandle.
If the function passed to the jsHandle.evaluateHandle returns a [Promise], then jsHandle.evaluateHandle would
wait for the promise to resolve and return its value.
See page.evaluateHandle(pageFunction[, arg]) for more details.
Function to be evaluated in the page context.
Optional arg: anyOptional argument to pass to pageFunction.
Optional NOTE Use locator-based locator.fill(value[, options]) instead. Read more about locators.
This method waits for actionability checks, focuses the element, fills it and triggers an
input event after filling. Note that you can pass an empty string to clear the input field.
If the target element is not an <input>, <textarea> or [contenteditable] element, this method throws an
error. However, if the element is inside the <label> element that has an associated
control, the control will be filled
instead.
To send fine-grained keyboard events, use locator.pressSequentially(text[, options]).
Value to set for the <input>, <textarea> or [contenteditable] element.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional noActions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
navigating to inaccessible pages. Defaults to false.
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.focus([options]) instead. Read more about locators.
Calls focus on the element.
NOTE Use locator-based locator.getAttribute(name[, options]) instead. Read more about locators.
Returns element attribute value.
Attribute name to get the value for.
The method returns a map with own property names as keys and JSHandle instances for the property values.
Usage
const handle = await page.evaluateHandle(() => ({ window, document }));
const properties = await handle.getProperties();
const windowHandle = properties.get('window');
const documentHandle = properties.get('document');
await handle.dispose();
NOTE Use locator-based locator.hover([options]) instead. Read more about locators.
This method hovers over the element by performing the following steps:
force option is set.position.noWaitAfter option is set.If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[]Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.
Optional noActions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
navigating to inaccessible pages. Defaults to false.
Optional position?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
NOTE Use locator-based locator.innerHTML([options]) instead. Read more about locators.
Returns the element.innerHTML.
NOTE Use locator-based locator.innerText([options]) instead. Read more about locators.
Returns the element.innerText.
NOTE Use locator-based locator.inputValue([options]) instead. Read more about locators.
Returns input.value for the selected <input> or <textarea> or <select> element.
Throws for non-input elements. However, if the element is inside the <label> element that has an associated
control, returns the value of the
control.
Optional options: { Optional
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.isChecked([options]) instead. Read more about locators.
Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
NOTE Use locator-based locator.isDisabled([options]) instead. Read more about locators.
Returns whether the element is disabled, the opposite of enabled.
NOTE Use locator-based locator.isEditable([options]) instead. Read more about locators.
Returns whether the element is editable.
NOTE Use locator-based locator.isEnabled([options]) instead. Read more about locators.
Returns whether the element is enabled.
NOTE Use locator-based locator.isHidden([options]) instead. Read more about locators.
Returns whether the element is hidden, the opposite of visible.
NOTE Use locator-based locator.isVisible([options]) instead. Read more about locators.
Returns whether the element is visible.
Returns a JSON representation of the object. If the object has a toJSON function, it will not be called.
NOTE The method will return an empty JSON object if the referenced object is not stringifiable. It will throw an error if the object has circular references.
NOTE Use locator-based locator.press(key[, options]) instead. Read more about locators.
Focuses the element, and then uses keyboard.down(key) and keyboard.up(key).
key can specify the intended
keyboardEvent.key value or a single character
to generate the text for. A superset of the key values can be found
here. Examples of the keys are:
F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab,
Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp,
etc.
Following modification shortcuts are also supported: Shift, Control, Alt, Meta, ShiftLeft,
ControlOrMeta.
Holding down Shift will type the text that corresponds to the key in the upper case.
If key is a single character, it is case-sensitive, so the values a and A will generate different respective
texts.
Shortcuts such as key: "Control+o", key: "Control++ or key: "Control+Shift+T" are supported as well. When
specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.
Name of the key to press or a character to generate, such as ArrowLeft or a.
Optional options: { Optional
Optional delay?: numberTime to wait between keydown and keyup in milliseconds. Defaults to 0.
Optional noActions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
navigating to inaccessible pages. Defaults to false.
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.screenshot([options]) instead. Read more about locators.
This method captures a screenshot of the page, clipped to the size and position of this particular element. If the element is covered by other elements, it will not be actually visible on the screenshot. If the element is a scrollable container, only the currently scrolled content will be visible on the screenshot.
This method waits for the actionability checks, then scrolls element into view before taking a screenshot. If the element is detached from DOM, the method throws an error.
Returns the buffer with the captured screenshot.
Optional options: { Optional
Optional animations?: "disabled" | "allow"When set to "disabled", stops CSS animations, CSS transitions and Web Animations. Animations get different
treatment depending on their duration:
transitionend event.Defaults to "allow" that leaves animations untouched.
Optional caret?: "initial" | "hide"When set to "hide", screenshot will hide text caret. When set to "initial", text caret behavior will not be
changed. Defaults to "hide".
Optional mask?: Locator[]Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink
box #FF00FF (customized by maskColor) that completely covers its bounding box.
Optional maskSpecify the color of the overlay box for masked elements, in
CSS color format. Default color is pink #FF00FF.
Optional omitHides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images.
Defaults to false.
Optional path?: stringThe file path to save the image to. The screenshot type will be inferred from file extension. If path is a
relative path, then it is resolved relative to the current working directory. If no path is provided, the image
won't be saved to the disk.
Optional quality?: numberThe quality of the image, between 0-100. Not applicable to png images.
Optional scale?: "css" | "device"When set to "css", screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this
will keep screenshots small. Using "device" option will produce a single pixel per each device pixel, so
screenshots of high-dpi devices will be twice as large or even larger.
Defaults to "device".
Optional style?: stringText of the stylesheet to apply while making the screenshot. This is where you can hide dynamic elements, make elements invisible or change their properties to help you creating repeatable screenshots. This stylesheet pierces the Shadow DOM and applies to the inner frames.
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional type?: "png" | "jpeg"Specify screenshot type, defaults to png.
NOTE Use locator-based locator.scrollIntoViewIfNeeded([options]) instead. Read more about locators.
This method waits for actionability checks, then tries to scroll element into view, unless
it is completely visible as defined by
IntersectionObserver's ratio.
Throws when elementHandle does not point to an element
connected to a Document or a ShadowRoot.
Optional options: { Optional
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.selectOption(values[, options]) instead. Read more about locators.
This method waits for actionability checks, waits until all specified options are present in
the <select> element and selects these options.
If the target element is not a <select> element, this method throws an error. However, if the element is inside
the <label> element that has an associated
control, the control will be used
instead.
Returns the array of option values that have been successfully selected.
Triggers a change and input event once all the provided options have been selected.
Usage
// Single selection matching the value or label
handle.selectOption('blue');
// single selection matching the label
handle.selectOption({ label: 'Blue' });
// multiple selection
handle.selectOption(['red', 'green', 'blue']);
Options to select. If the <select> has the multiple attribute, all matching options are selected, otherwise
only the first option matching one of the passed options is selected. String values are matching both values and
labels. Option is considered matching if all specified properties match.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional noActions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
navigating to inaccessible pages. Defaults to false.
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.selectText([options]) instead. Read more about locators.
This method waits for actionability checks, then focuses the element and selects all its text content.
If the element is inside the <label> element that has an associated
control, focuses and selects text in
the control instead.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.setChecked(checked[, options]) instead. Read more about locators.
This method checks or unchecks an element by performing the following steps:
force option is set. If
the element is detached during the checks, the whole action is retried.noWaitAfter option is set.When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Whether to check or uncheck the checkbox.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional noActions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
navigating to inaccessible pages. Defaults to false.
Optional position?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
NOTE Use locator-based locator.setInputFiles(files[, options]) instead. Read more about locators.
Sets the value of the file input to these file paths or files. If some of the filePaths are relative paths, then
they are resolved relative to the current working directory. For empty array, clears the selected files.
This method expects ElementHandle to point to an
input element. However, if the element is inside
the <label> element that has an associated
control, targets the control instead.
Optional options: { Optional
Optional noActions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
navigating to inaccessible pages. Defaults to false.
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.tap([options]) instead. Read more about locators.
This method taps the element by performing the following steps:
force option is set.position.noWaitAfter option is set.If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
NOTE elementHandle.tap() requires that the hasTouch option of the browser context be set to true.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[]Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.
Optional noActions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
navigating to inaccessible pages. Defaults to false.
Optional position?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
NOTE Use locator-based locator.textContent([options]) instead. Read more about locators.
Returns the node.textContent.
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(key[, options]).
Usage
A text to type into a focused element.
Optional options: { Optional
Optional delay?: numberTime to wait between key presses in milliseconds. Defaults to 0.
Optional noActions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
navigating to inaccessible pages. Defaults to false.
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
In most cases, you should use locator.fill(value[, options]) instead. You only need to press keys one by one if there is special keyboard handling on the page - in this case use locator.pressSequentially(text[, options]).
NOTE Use locator-based locator.uncheck([options]) instead. Read more about locators.
This method checks the element by performing the following steps:
force option is set.noWaitAfter option is set.If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Optional options: { Optional
Optional force?: booleanWhether to bypass the actionability checks. Defaults to false.
Optional noActions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You
can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as
navigating to inaccessible pages. Defaults to false.
Optional position?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optional trial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
Returns when the element satisfies the state.
Depending on the state parameter, this method waits for one of the actionability checks to
pass. This method throws when the element is detached while waiting, unless waiting for the "hidden" state.
"visible" Wait until the element is visible."hidden" Wait until the element is not visible or not attached. Note that
waiting for hidden does not throw when the element detaches."stable" Wait until the element is both visible and
stable."enabled" Wait until the element is enabled."disabled" Wait until the element is not enabled."editable" Wait until the element is editable.If the element does not satisfy the condition for the timeout milliseconds, this method will throw.
A state to wait for, see below for more details.
Optional options: { Optional
Optional timeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use web assertions that assert visibility or a locator-based locator.waitFor([options]) instead.
Returns element specified by selector when it satisfies state option. Returns null if waiting for hidden or
detached.
Wait for the selector relative to the element handle to satisfy state option (either appear/disappear from dom,
or become visible/hidden). If at the moment of calling the method selector already satisfies the condition, the
method will return immediately. If the selector doesn't satisfy the condition for the timeout milliseconds, the
function will throw.
Usage
await page.setContent(`<div><span></span></div>`);
const div = await page.$('div');
// Waiting for the 'span' selector relative to the div.
const span = await div.waitForSelector('span', { state: 'attached' });
NOTE This method does not work across navigations, use page.waitForSelector(selector[, options]) instead.
A selector to query for.
Optional options: ElementHandleWaitForSelectorOptionsNotHiddenOptional NOTE Use web assertions that assert visibility or a locator-based locator.waitFor([options]) instead.
Returns element specified by selector when it satisfies state option. Returns null if waiting for hidden or
detached.
Wait for the selector relative to the element handle to satisfy state option (either appear/disappear from dom,
or become visible/hidden). If at the moment of calling the method selector already satisfies the condition, the
method will return immediately. If the selector doesn't satisfy the condition for the timeout milliseconds, the
function will throw.
Usage
await page.setContent(`<div><span></span></div>`);
const div = await page.$('div');
// Waiting for the 'span' selector relative to the div.
const span = await div.waitForSelector('span', { state: 'attached' });
NOTE This method does not work across navigations, use page.waitForSelector(selector[, options]) instead.
A selector to query for.
Optional options: ElementHandleWaitForSelectorOptionsNotHiddenOptional NOTE Use web assertions that assert visibility or a locator-based locator.waitFor([options]) instead.
Returns element specified by selector when it satisfies state option. Returns null if waiting for hidden or
detached.
Wait for the selector relative to the element handle to satisfy state option (either appear/disappear from dom,
or become visible/hidden). If at the moment of calling the method selector already satisfies the condition, the
method will return immediately. If the selector doesn't satisfy the condition for the timeout milliseconds, the
function will throw.
Usage
await page.setContent(`<div><span></span></div>`);
const div = await page.$('div');
// Waiting for the 'span' selector relative to the div.
const span = await div.waitForSelector('span', { state: 'attached' });
NOTE This method does not work across navigations, use page.waitForSelector(selector[, options]) instead.
A selector to query for.
NOTE Use web assertions that assert visibility or a locator-based locator.waitFor([options]) instead.
Returns element specified by selector when it satisfies state option. Returns null if waiting for hidden or
detached.
Wait for the selector relative to the element handle to satisfy state option (either appear/disappear from dom,
or become visible/hidden). If at the moment of calling the method selector already satisfies the condition, the
method will return immediately. If the selector doesn't satisfy the condition for the timeout milliseconds, the
function will throw.
Usage
await page.setContent(`<div><span></span></div>`);
const div = await page.$('div');
// Waiting for the 'span' selector relative to the div.
const span = await div.waitForSelector('span', { state: 'attached' });
NOTE This method does not work across navigations, use page.waitForSelector(selector[, options]) instead.
A selector to query for.
Generated using TypeDoc
ElementHandle represents an in-page DOM element. ElementHandles can be created with the page.$(selector[, options]) method.
NOTE The use of ElementHandle is discouraged, use Locator objects and web-first assertions instead.
ElementHandle prevents DOM element from garbage collection unless the handle is disposed with jsHandle.dispose(). ElementHandles are auto-disposed when their origin frame gets navigated.
ElementHandle instances can be used as an argument in page.$eval(selector, pageFunction[, arg, options]) and page.evaluate(pageFunction[, arg]) methods.
The difference between the Locator and ElementHandle is that the ElementHandle points to a particular element, while Locator captures the logic of how to retrieve an element.
In the example below, handle points to a particular DOM element on page. If that element changes text or is used by React to render an entirely different component, handle is still pointing to that very DOM element. This can lead to unexpected behaviors.
With the locator, every time the
elementis used, up-to-date DOM element is located in the page using the selector. So in the snippet below, underlying DOM element is going to be located twice.