Skip to main content

Locator

Locators are the central piece of Playwright's auto-waiting and retry-ability. In a nutshell, locators represent a way to find element(s) on the page at any moment. Locator can be created with the page.locator(selector[, options]) method.

Learn more about locators.

locator.allInnerTexts()​

Added in: v1.14

Returns an array of node.innerText values for all matching nodes.

locator.allTextContents()​

Added in: v1.14

Returns an array of node.textContent values for all matching nodes.

locator.boundingBox([options])​

Added in: v1.14

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.

const box = await element.boundingBox();
await page.mouse.click(box.x + box.width / 2, box.y + box.height / 2);

locator.check([options])​

Added in: v1.14
  • options? <Object>
    • force? <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • noWaitAfter? <boolean> Actions 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.#
    • position? <Object> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • timeout? <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial? <boolean> When 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: <Promise<void>>#

This method checks the element by performing the following steps:

  1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
  2. Wait for actionability checks on the element, unless force option is set.
  3. Scroll the element into view if needed.
  4. Use page.mouse to click in the center of the element.
  5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
  6. Ensure that the element is now checked. If not, this method throws.

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.

locator.click([options])​

Added in: v1.14
  • options? <Object>
    • button? <"left"|"right"|"middle"> Defaults to left.#
    • clickCount? <number> defaults to 1. See UIEvent.detail.#
    • delay? <number> Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.#
    • force? <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • modifiers? <Array<"Alt"|"Control"|"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.#
    • noWaitAfter? <boolean> Actions 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.#
    • position? <Object> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • timeout? <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial? <boolean> When 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: <Promise<void>>#

This method clicks the element by performing the following steps:

  1. Wait for actionability checks on the element, unless force option is set.
  2. Scroll the element into view if needed.
  3. Use page.mouse to click in the center of the element, or the specified position.
  4. Wait for initiated navigations to either succeed or fail, unless 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.

locator.count()​

Added in: v1.14

Returns the number of elements matching given selector.

locator.dblclick([options])​

Added in: v1.14
  • options? <Object>
    • button? <"left"|"right"|"middle"> Defaults to left.#
    • delay? <number> Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.#
    • force? <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • modifiers? <Array<"Alt"|"Control"|"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.#
    • noWaitAfter? <boolean> Actions 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.#
    • position? <Object> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • timeout? <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial? <boolean> When 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: <Promise<void>>#

This method double clicks the element by performing the following steps:

  1. Wait for actionability checks on the element, unless force option is set.
  2. Scroll the element into view if needed.
  3. Use page.mouse to double click in the center of the element, or the specified position.
  4. Wait for initiated navigations to either succeed or fail, unless 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

element.dblclick() dispatches two click events and a single dblclick event.

locator.dispatchEvent(type[, eventInit, options])​

Added in: v1.14

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().

await element.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 element.dispatchEvent('dragstart', { dataTransfer });

locator.dragTo(target[, options])​

Added in: v1.18
  • target <Locator> Locator of the element to drag to.#
  • options? <Object>
    • force? <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • noWaitAfter? <boolean> Actions 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.#
    • sourcePosition? <Object> Clicks on the source element at this point relative to the top-left corner of the element's padding box. If not specified, some visible point of the element is used.#
    • targetPosition? <Object> Drops on the target element at this point relative to the top-left corner of the element's padding box. If not specified, some visible point of the element is used.#
    • timeout? <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial? <boolean> When 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: <Promise<void>>#

This method drags the locator to another target locator or target position. It will first move to the source element, perform a mousedown, then move to the target element or position and perform a mouseup.

const source = page.locator('#source');
const target = page.locator('#target');

await source.dragTo(target);
// or specify exact positions relative to the top-left corners of the elements:
await source.dragTo(target, {
  sourcePosition: { x: 34, y: 7 },
  targetPosition: { x: 10, y: 20 },
});

locator.elementHandle([options])​

Added in: v1.14

Resolves given locator to the first matching DOM element. If no elements matching the query are visible, waits for them up to a given timeout. If multiple elements match the selector, throws.

locator.elementHandles()​

Added in: v1.14

Resolves given locator to all matching DOM elements.

locator.evaluate(pageFunction[, arg, options])​

Added in: v1.14

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.

Examples:

const tweets = page.locator('.tweet .retweets');
expect(await tweets.evaluate(node => node.innerText)).toBe('10 retweets');

locator.evaluateAll(pageFunction[, arg])​

Added in: v1.14

The method finds all elements matching the specified locator and passes an array of matched elements as a first argument to pageFunction. Returns the result of pageFunction invocation.

If pageFunction returns a Promise, then locator.evaluateAll(pageFunction[, arg]) would wait for the promise to resolve and return its value.

Examples:

const elements = page.locator('div');
const divCounts = await elements.evaluateAll((divs, min) => divs.length >= min, 10);

locator.evaluateHandle(pageFunction[, arg, options])​

Added in: v1.14

Returns the return value of pageFunction as a JSHandle.

This method passes this handle as the first argument to pageFunction.

The only difference between locator.evaluate(pageFunction[, arg, options]) and locator.evaluateHandle(pageFunction[, arg, options]) is that locator.evaluateHandle(pageFunction[, arg, options]) returns JSHandle.

If the function passed to the locator.evaluateHandle(pageFunction[, arg, options]) returns a Promise, then locator.evaluateHandle(pageFunction[, arg, options]) would wait for the promise to resolve and return its value.

See page.evaluateHandle(pageFunction[, arg]) for more details.

locator.fill(value[, options])​

Added in: v1.14
  • value <string> Value to set for the <input>, <textarea> or [contenteditable] element.#
  • options? <Object>
    • force? <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • noWaitAfter? <boolean> Actions 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.#
    • timeout? <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
  • returns: <Promise<void>>#

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.type(text[, options]).

locator.filter([options])​

Added in: v1.22

  • options? <Object>

    • has? <Locator> Matches elements containing an element that matches an inner locator. Inner locator is queried against the outer one. For example, article that has text=Playwright matches <article><div>Playwright</div></article>.#

      Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.

    • hasText? <string|RegExp> Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When passed a string, matching is case-insensitive and searches for a substring. For example, "Playwright" matches <article><div>Playwright</div></article>.#

  • returns: <Locator>#

This method narrows existing locator according to the options, for example filters by text. It can be chained to filter multiple times.

const rowLocator = page.locator('tr');
// ...
await rowLocator
    .filter({ hasText: 'text in column 1' })
    .filter({ has: page.getByRole('button', { name: 'column 2 button' }) })
    .screenshot();

locator.first()​

Added in: v1.14

Returns locator to the first matching element.

locator.focus([options])​

Added in: v1.14

Calls focus on the element.

locator.frameLocator(selector)​

Added in: v1.17

When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in that iframe:

const locator = page.frameLocator('iframe').getByText('Submit');
await locator.click();

locator.getAttribute(name[, options])​

Added in: v1.14

Returns element attribute value.

locator.getByAltText(text[, options])​

Added in: v1.27
  • text <string|RegExp> Text to locate the element for.#
  • options? <Object>
    • exact? <boolean> Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.#
  • returns: <Locator>#

Allows locating elements by their alt text. For example, this method will find the image by alt text "Castle":

<img alt='Castle'>

locator.getByLabel(text[, options])​

Added in: v1.27
  • text <string|RegExp> Text to locate the element for.#
  • options? <Object>
    • exact? <boolean> Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.#
  • returns: <Locator>#

Allows locating input elements by the text of the associated label. For example, this method will find the input by label text Password in the following DOM:

<label for="password-input">Password:</label>
<input id="password-input">

locator.getByPlaceholder(text[, options])​

Added in: v1.27
  • text <string|RegExp> Text to locate the element for.#
  • options? <Object>
    • exact? <boolean> Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.#
  • returns: <Locator>#

Allows locating input elements by the placeholder text. For example, this method will find the input by placeholder "Country":

<input placeholder="Country">

locator.getByRole(role[, options])​

Added in: v1.27

  • role <"alert"|"alertdialog"|"application"|"article"|"banner"|"blockquote"|"button"|"caption"|"cell"|"checkbox"|"code"|"columnheader"|"combobox"|"complementary"|"contentinfo"|"definition"|"deletion"|"dialog"|"directory"|"document"|"emphasis"|"feed"|"figure"|"form"|"generic"|"grid"|"gridcell"|"group"|"heading"|"img"|"insertion"|"link"|"list"|"listbox"|"listitem"|"log"|"main"|"marquee"|"math"|"meter"|"menu"|"menubar"|"menuitem"|"menuitemcheckbox"|"menuitemradio"|"navigation"|"none"|"note"|"option"|"paragraph"|"presentation"|"progressbar"|"radio"|"radiogroup"|"region"|"row"|"rowgroup"|"rowheader"|"scrollbar"|"search"|"searchbox"|"separator"|"slider"|"spinbutton"|"status"|"strong"|"subscript"|"superscript"|"switch"|"tab"|"table"|"tablist"|"tabpanel"|"term"|"textbox"|"time"|"timer"|"toolbar"|"tooltip"|"tree"|"treegrid"|"treeitem"> Required aria role.#

  • options? <Object>

    • checked? <boolean> An attribute that is usually set by aria-checked or native <input type=checkbox> controls. Available values for checked are true, false and "mixed".#

      Learn more about aria-checked.

    • disabled? <boolean> A boolean attribute that is usually set by aria-disabled or disabled.#

      note

      Unlike most other attributes, disabled is inherited through the DOM hierarchy. Learn more about aria-disabled.

    • expanded? <boolean> A boolean attribute that is usually set by aria-expanded.#

      Learn more about aria-expanded.

    • includeHidden? <boolean> A boolean attribute that controls whether hidden elements are matched. By default, only non-hidden elements, as defined by ARIA, are matched by role selector.#

      Learn more about aria-hidden.

    • level? <number> A number attribute that is usually present for roles heading, listitem, row, treeitem, with default values for <h1>-<h6> elements.#

      Learn more about aria-level.

    • name? <string|RegExp> A string attribute that matches accessible name.#

      Learn more about accessible name.

    • pressed? <boolean> An attribute that is usually set by aria-pressed. Available values for pressed are true, false and "mixed".#

      Learn more about aria-pressed.

    • selected? <boolean> A boolean attribute that is usually set by aria-selected.#

      Learn more about aria-selected.

  • returns: <Locator>#

Allows locating elements by their ARIA role, ARIA attributes and accessible name. Note that role selector does not replace accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.

Note that many html elements have an implicitly defined role that is recognized by the role selector. You can find all the supported roles here. ARIA guidelines do not recommend duplicating implicit roles and attributes by setting role and/or aria-* attributes to default values.

locator.getByTestId(testId)​

Added in: v1.27

Locate element by the test id. By default, the data-testid attribute is used as a test id. Use selectors.setTestIdAttribute(attributeName) to configure a different test id attribute if necessary.

locator.getByText(text[, options])​

Added in: v1.27
  • text <string|RegExp> Text to locate the element for.#
  • options? <Object>
    • exact? <boolean> Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.#
  • returns: <Locator>#

Allows locating elements that contain given text. Consider the following DOM structure:

<div>Hello <span>world</span></div>
<div>Hello</div>

You can locate by text substring, exact string, or a regular expression:

// Matches <span>
page.getByText('world')

// Matches first <div>
page.getByText('Hello world')

// Matches second <div>
page.getByText('Hello', { exact: true })

// Matches both <div>s
page.getByText(/Hello/)

// Matches second <div>
page.getByText(/^hello$/i)

See also locator.filter([options]) that allows to match by another criteria, like an accessible role, and then filter by the text content.

note

Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace.

note

Input elements of the type button and submit are matched by their value instead of the text content. For example, locating by text "Log in" matches <input type=button value="Log in">.

locator.getByTitle(text[, options])​

Added in: v1.27
  • text <string|RegExp> Text to locate the element for.#
  • options? <Object>
    • exact? <boolean> Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.#
  • returns: <Locator>#

Allows locating elements by their title. For example, this method will find the button by its title "Submit":

<button title='Place the order'>Order Now</button>

locator.highlight()​

Added in: v1.20

Highlight the corresponding element(s) on the screen. Useful for debugging, don't commit the code that uses locator.highlight().

locator.hover([options])​

Added in: v1.14
  • options? <Object>
    • force? <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • modifiers? <Array<"Alt"|"Control"|"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.#
    • position? <Object> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • timeout? <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial? <boolean> When 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: <Promise<void>>#

This method hovers over the element by performing the following steps:

  1. Wait for actionability checks on the element, unless force option is set.
  2. Scroll the element into view if needed.
  3. Use page.mouse to hover over the center of the element, or the specified position.
  4. Wait for initiated navigations to either succeed or fail, unless 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.

locator.innerHTML([options])​

Added in: v1.14

Returns the element.innerHTML.

locator.innerText([options])​

Added in: v1.14

Returns the element.innerText.

locator.inputValue([options])​

Added in: v1.14

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.

locator.isChecked([options])​

Added in: v1.14

Returns whether the element is checked. Throws if the element is not a checkbox or radio input.

locator.isDisabled([options])​

Added in: v1.14

Returns whether the element is disabled, the opposite of enabled.

locator.isEditable([options])​

Added in: v1.14

Returns whether the element is editable.

locator.isEnabled([options])​

Added in: v1.14

Returns whether the element is enabled.

locator.isHidden([options])​

Added in: v1.14

Returns whether the element is hidden, the opposite of visible.

locator.isVisible([options])​

Added in: v1.14

Returns whether the element is visible.

locator.last()​

Added in: v1.14

Returns locator to the last matching element.

locator.locator(selector[, options])​

Added in: v1.14

  • selector <string> A selector to use when resolving DOM element. See working with selectors for more details.#

  • options? <Object>

    • has? <Locator> Matches elements containing an element that matches an inner locator. Inner locator is queried against the outer one. For example, article that has text=Playwright matches <article><div>Playwright</div></article>.#

      Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.

    • hasText? <string|RegExp> Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When passed a string, matching is case-insensitive and searches for a substring. For example, "Playwright" matches <article><div>Playwright</div></article>.#

  • returns: <Locator>#

The method finds an element matching the specified selector in the locator's subtree. It also accepts filter options, similar to locator.filter([options]) method.

Learn more about locators.

locator.nth(index)​

Added in: v1.14

Returns locator to the n-th matching element. It's zero based, nth(0) selects the first element.

locator.page()​

Added in: v1.19

A page this locator belongs to.

locator.press(key[, options])​

Added in: v1.14
  • key <string> Name of the key to press or a character to generate, such as ArrowLeft or a.#
  • options? <Object>
    • delay? <number> Time to wait between keydown and keyup in milliseconds. Defaults to 0.#
    • noWaitAfter? <boolean> Actions 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.#
    • timeout? <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
  • returns: <Promise<void>>#

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.

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" 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.

locator.screenshot([options])​

Added in: v1.14

  • options? <Object>

    • animations? <"disabled"|"allow"> When set to "disabled", stops CSS animations, CSS transitions and Web Animations. Animations get different treatment depending on their duration:#

      • finite animations are fast-forwarded to completion, so they'll fire transitionend event.
      • infinite animations are canceled to initial state, and then played over after the screenshot.

      Defaults to "allow" that leaves animations untouched.

    • caret? <"hide"|"initial"> When set to "hide", screenshot will hide text caret. When set to "initial", text caret behavior will not be changed. Defaults to "hide".#

    • mask? <Array<Locator>> Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink box #FF00FF that completely covers its bounding box.#

    • omitBackground? <boolean> Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images. Defaults to false.#

    • path? <string> The 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.#

    • quality? <number> The quality of the image, between 0-100. Not applicable to png images.#

    • 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 screenhots of high-dpi devices will be twice as large or even larger.#

      Defaults to "device".

    • timeout? <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#

    • type? <"png"|"jpeg"> Specify screenshot type, defaults to png.#

  • returns: <Promise<Buffer>>#

This method captures a screenshot of the page, clipped to the size and position of a particular element matching the locator. 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.

locator.scrollIntoViewIfNeeded([options])​

Added in: v1.14

This method waits for actionability checks, then tries to scroll element into view, unless it is completely visible as defined by IntersectionObserver's ratio.

locator.selectOption(values[, options])​

Added in: v1.14
  • values <null|string|ElementHandle|Array<string>|Object|Array<ElementHandle>|Array<Object>> 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 equivalent to {value:'string'}. Option is considered matching if all specified properties match.#
    • value? <string> Matches by option.value. Optional.
    • label? <string> Matches by option.label. Optional.
    • index? <number> Matches by the index. Optional.
  • options? <Object>
    • force? <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • noWaitAfter? <boolean> Actions 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.#
    • timeout? <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
  • returns: <Promise<Array<string>>>#

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.

// single selection matching the value
element.selectOption('blue');

// single selection matching the label
element.selectOption({ label: 'Blue' });

// multiple selection
element.selectOption(['red', 'green', 'blue']);

locator.selectText([options])​

Added in: v1.14

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.

locator.setChecked(checked[, options])​

Added in: v1.15
  • checked <boolean> Whether to check or uncheck the checkbox.#
  • options? <Object>
    • force? <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • noWaitAfter? <boolean> Actions 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.#
    • position? <Object> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • timeout? <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial? <boolean> When 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: <Promise<void>>#

This method checks or unchecks an element by performing the following steps:

  1. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
  2. If the element already has the right checked state, this method returns immediately.
  3. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
  4. Scroll the element into view if needed.
  5. Use page.mouse to click in the center of the element.
  6. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
  7. Ensure that the element is now checked or unchecked. If not, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

locator.setInputFiles(files[, options])​

Added in: v1.14

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 Locator to point to an input element. However, if the element is inside the <label> element that has an associated control, targets the control instead.

locator.tap([options])​

Added in: v1.14
  • options? <Object>
    • force? <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • modifiers? <Array<"Alt"|"Control"|"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.#
    • noWaitAfter? <boolean> Actions 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.#
    • position? <Object> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • timeout? <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial? <boolean> When 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: <Promise<void>>#

This method taps the element by performing the following steps:

  1. Wait for actionability checks on the element, unless force option is set.
  2. Scroll the element into view if needed.
  3. Use page.touchscreen to tap the center of the element, or the specified position.
  4. Wait for initiated navigations to either succeed or fail, unless 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

element.tap() requires that the hasTouch option of the browser context be set to true.

locator.textContent([options])​

Added in: v1.14

Returns the node.textContent.

locator.type(text[, options])​

Added in: v1.14
  • text <string> A text to type into a focused element.#
  • options? <Object>
    • delay? <number> Time to wait between key presses in milliseconds. Defaults to 0.#
    • noWaitAfter? <boolean> Actions 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.#
    • timeout? <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
  • returns: <Promise<void>>#

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 locator.press(key[, options]).

await element.type('Hello'); // Types instantly
await element.type('World', {delay: 100}); // Types slower, like a user

An example of typing into a text field and then submitting the form:

const element = page.getByLabel('Password');
await element.type('my password');
await element.press('Enter');

locator.uncheck([options])​

Added in: v1.14
  • options? <Object>
    • force? <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • noWaitAfter? <boolean> Actions 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.#
    • position? <Object> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • timeout? <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial? <boolean> When 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: <Promise<void>>#

This method checks the element by performing the following steps:

  1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already unchecked, this method returns immediately.
  2. Wait for actionability checks on the element, unless force option is set.
  3. Scroll the element into view if needed.
  4. Use page.mouse to click in the center of the element.
  5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
  6. Ensure that the element is now unchecked. If not, this method throws.

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.

locator.waitFor([options])​

Added in: v1.16
  • options? <Object>
    • state? <"attached"|"detached"|"visible"|"hidden"> Defaults to 'visible'. Can be either:#
      • 'attached' - wait for element to be present in DOM.
      • 'detached' - wait for element to not be present in DOM.
      • 'visible' - wait for element to have non-empty bounding box and no visibility:hidden. Note that element without any content or with display:none has an empty bounding box and is not considered visible.
      • 'hidden' - wait for element to be either detached from DOM, or have an empty bounding box or visibility:hidden. This is opposite to the 'visible' option.
    • timeout? <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
  • returns: <Promise<void>>#

Returns when element specified by locator satisfies the state option.

If target element already satisfies the condition, the method returns immediately. Otherwise, waits for up to timeout milliseconds until the condition is met.

const orderSent = page.locator('#order-sent');
await orderSent.waitFor();