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. A locator can be created with the Page#locator method.

Learn more about locators.

all

def all

When the locator points to a list of elements, this returns an array of locators, pointing to their respective elements.

NOTE: Locator#all does not wait for elements to match the locator, and instead immediately returns whatever is present in the page.

When the list of elements changes dynamically, Locator#all will produce unpredictable and flaky results.

When the list of elements is stable, but loaded dynamically, wait for the full list to finish loading before calling Locator#all.

Usage

page.get_by_role('listitem').all.each do |li|
  li.click
end

all_inner_texts

def all_inner_texts

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

NOTE: If you need to assert text on the page, prefer LocatorAssertions#to_have_text with useInnerText option to avoid flakiness. See assertions guide for more details.

Usage

texts = page.get_by_role("link").all_inner_texts

all_text_contents

def all_text_contents

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

NOTE: If you need to assert text on the page, prefer LocatorAssertions#to_have_text to avoid flakiness. See assertions guide for more details.

Usage

texts = page.get_by_role("link").all_text_contents

and

def and(locator)

Creates a locator that matches both this locator and the argument locator.

Usage

The following example finds a button with a specific title.

button = page.get_by_role("button").and(page.get_by_title("Subscribe"))

aria_snapshot

def aria_snapshot(timeout: nil)

Captures the aria snapshot of the given element. Read more about aria snapshots and LocatorAssertions#to_match_aria_snapshot for the corresponding assertion.

Usage

page.get_by_role("link").aria_snapshot

Details

This method captures the aria snapshot of the given element. The snapshot is a string that represents the state of the element and its children. The snapshot can be used to assert the state of the element in the test, or to compare it to state in the future.

The ARIA snapshot is represented using YAML markup language:

The keys of the objects are the roles and optional accessible names of the elements.
The values are either text content or an array of child elements.
Generic static text can be represented with the text key.

Below is the HTML markup and the respective ARIA snapshot:

<ul aria-label="Links">
  <li><a href="/">Home</a></li>
  <li><a href="/about">About</a></li>
<ul>

- list "Links":
  - listitem:
    - link "Home"
  - listitem:
    - link "About"

blur

def blur(timeout: nil)

Calls blur on the element.

bounding_box

def bounding_box(timeout: nil)

This method returns the bounding box of the element matching the locator, 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.

Details

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

element = page.get_by_role("button")
box = element.bounding_box
page.mouse.click(
  box["x"] + box["width"] / 2,
  box["y"] + box["height"] / 2,
)

check

def check(
      force: nil,
      noWaitAfter: nil,
      position: nil,
      timeout: nil,
      trial: nil)

Ensure that checkbox or radio element is checked.

Details

Performs the following steps:

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.
Wait for actionability checks on the element, unless force option is set.
Scroll the element into view if needed.
Use Page#mouse to click in the center of the element.
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.

Usage

page.get_by_role("checkbox").check

clear

def clear(force: nil, noWaitAfter: nil, timeout: nil)

Clear the input field.

Details

This method waits for actionability checks, focuses the element, clears it and triggers an input event after clearing.

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 cleared instead.

Usage

page.get_by_role("textbox").clear

click

def click(
      button: nil,
      clickCount: nil,
      delay: nil,
      force: nil,
      modifiers: nil,
      noWaitAfter: nil,
      position: nil,
      timeout: nil,
      trial: nil)

Click an element.

Details

This method clicks the element by performing the following steps:

Wait for actionability checks on the element, unless force option is set.
Scroll the element into view if needed.
Use Page#mouse to click in the center of the element, or the specified position.
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.

Usage

Click a button:

page.get_by_role("button").click

Shift-right-click at a specific position on a canvas:

page.locator("canvas").click(button: "right", modifiers: ["Shift"], position: { x: 23, y: 32 })

count

def count

Returns the number of elements matching the locator.

NOTE: If you need to assert the number of elements on the page, prefer LocatorAssertions#to_have_count to avoid flakiness. See assertions guide for more details.

Usage

count = page.get_by_role("listitem").count

dblclick

def dblclick(
      button: nil,
      delay: nil,
      force: nil,
      modifiers: nil,
      noWaitAfter: nil,
      position: nil,
      timeout: nil,
      trial: nil)

Double-click an element.

Details

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

Wait for actionability checks on the element, unless force option is set.
Scroll the element into view if needed.
Use Page#mouse to double click in the center of the element, or the specified position.

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.

dispatch_event

def dispatch_event(type, eventInit: nil, timeout: nil)

Programmatically dispatch an event on the matching element.

Usage

locator.dispatch_event("click")

Details

The snippet above 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().

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 data_transfer in chromium and firefox
data_transfer = page.evaluate_handle("new DataTransfer()")
locator.dispatch_event("dragstart", eventInit: { dataTransfer: data_transfer })

drag_to

def drag_to(
      target,
      force: nil,
      noWaitAfter: nil,
      sourcePosition: nil,
      targetPosition: nil,
      timeout: nil,
      trial: nil)

Drag the source element towards the target element and drop it.

Details

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.

Usage

source = page.locator("#source")
target = page.locator("#target")

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

element_handle

def element_handle(timeout: nil)

Resolves given locator to the first matching DOM element. If there are no matching elements, waits for one. If multiple elements match the locator, throws.

element_handles

def element_handles

Resolves given locator to all matching DOM elements. If there are no matching elements, returns an empty list.

content_frame

def content_frame

Returns a FrameLocator object pointing to the same iframe as this locator.

Useful when you have a Locator object obtained somewhere, and later on would like to interact with the content inside the frame.

For a reverse operation, use FrameLocator#owner.

Usage

locator = page.locator('iframe[name="embedded"]')
# ...
frame_locator = locator.content_frame
frame_locator.get_by_role("button").click

evaluate

def evaluate(expression, arg: nil, timeout: nil)

Execute JavaScript code in the page, taking the matching element as an argument.

Details

Returns the return value of expression, called with the matching element as a first argument, and arg as a second argument.

If expression returns a Promise, this method will wait for the promise to resolve and return its value.

If expression throws or rejects, this method throws.

Usage

tweet = page.query_selector(".tweet .retweets")
tweet.evaluate("node => node.innerText") # => "10 retweets"

evaluate_all

def evaluate_all(expression, arg: nil)

Execute JavaScript code in the page, taking all matching elements as an argument.

Details

Returns the return value of expression, called with an array of all matching elements as a first argument, and arg as a second argument.

If expression returns a Promise, this method will wait for the promise to resolve and return its value.

If expression throws or rejects, this method throws.

Usage

locator = page.locator("div")
more_than_ten = locator.evaluate_all("(divs, min) => divs.length >= min", arg: 10)

evaluate_handle

def evaluate_handle(expression, arg: nil, timeout: nil)

Execute JavaScript code in the page, taking the matching element as an argument, and return a JSHandle with the result.

Details

Returns the return value of expression as aJSHandle, called with the matching element as a first argument, and arg as a second argument.

The only difference between Locator#evaluate and Locator#evaluate_handle is that Locator#evaluate_handle returns JSHandle.

If expression returns a Promise, this method will wait for the promise to resolve and return its value.

If expression throws or rejects, this method throws.

See Page#evaluate_handle for more details.

fill

def fill(value, force: nil, noWaitAfter: nil, timeout: nil)

Set a value to the input field.

Usage

page.get_by_role("textbox").fill("example value")

Details

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.

To send fine-grained keyboard events, use Locator#press_sequentially.

filter

def filter(has: nil, hasNot: nil, hasNotText: nil, hasText: nil)

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

Usage

row_locator = page.locator("tr")
# ...
row_locator.
    filter(hasText: "text in column 1").
    filter(has: page.get_by_role("button", name: "column 2 button")).
    screenshot

first

def first

Returns locator to the first matching element.

focus

def focus(timeout: nil)

Calls focus on the matching element.

frame_locator

def frame_locator(selector)

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

Usage

locator = page.frame_locator("iframe").get_by_text("Submit")
locator.click

get_attribute

def get_attribute(name, timeout: nil)

alias: []

Returns the matching element's attribute value.

NOTE: If you need to assert an element's attribute, prefer LocatorAssertions#to_have_attribute to avoid flakiness. See assertions guide for more details.

get_by_alt_text

def get_by_alt_text(text, exact: nil)

Allows locating elements by their alt text.

Usage

For example, this method will find the image by alt text "Playwright logo":

<img alt='Playwright logo'>

page.get_by_alt_text("Playwright logo").click

get_by_label

def get_by_label(text, exact: nil)

Allows locating input elements by the text of the associated <label> or aria-labelledby element, or by the aria-label attribute.

Usage

For example, this method will find inputs by label "Username" and "Password" in the following DOM:

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

page.get_by_label("Username").fill("john")
page.get_by_label("Password").fill("secret")

get_by_placeholder

def get_by_placeholder(text, exact: nil)

Allows locating input elements by the placeholder text.

Usage

For example, consider the following DOM structure.

<input type="email" placeholder="name@example.com" />

You can fill the input after locating it by the placeholder text:

page.get_by_placeholder("name@example.com").fill("playwright@microsoft.com")

get_by_role

def get_by_role(
      role,
      checked: nil,
      disabled: nil,
      exact: nil,
      expanded: nil,
      includeHidden: nil,
      level: nil,
      name: nil,
      pressed: nil,
      selected: nil)

Allows locating elements by their ARIA role, ARIA attributes and accessible name.

Usage

Consider the following DOM structure.

<h3>Sign up</h3>
<label>
  <input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>

You can locate each element by it's implicit role:

page.get_by_role("heading", name: "Sign up").visible? # => true
page.get_by_role("checkbox", name: "Subscribe").check
page.get_by_role("button", name: /submit/i).click

Details

Role selector does not replace accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.

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.

get_by_test_id

def get_by_test_id(testId)

Locate element by the test id.

Usage

Consider the following DOM structure.

<button data-testid="directions">Itinéraire</button>

You can locate the element by it's test id:

page.get_by_test_id("directions").click

Details

By default, the data-testid attribute is used as a test id. Use Selectors#set_test_id_attribute to configure a different test id attribute if necessary.

get_by_text

def get_by_text(text, exact: nil)

Allows locating elements that contain given text.

See also Locator#filter that allows to match by another criteria, like an accessible role, and then filter by the text content.

Usage

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:

page.content = <<~HTML
  <div>Hello <span>world</span></div>
  <div>Hello</div>
HTML

# Matches <span>
locator = page.get_by_text("world")
expect(locator.evaluate('e => e.outerHTML')).to eq('<span>world</span>')

# Matches first <div>
locator = page.get_by_text("Hello world")
expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello <span>world</span></div>')

# Matches second <div>
locator = page.get_by_text("Hello", exact: true)
expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')

# Matches both <div>s
locator = page.get_by_text(/Hello/)
expect(locator.count).to eq(2)
expect(locator.first.evaluate('e => e.outerHTML')).to eq('<div>Hello <span>world</span></div>')
expect(locator.last.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')

# Matches second <div>
locator = page.get_by_text(/^hello$/i)
expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')

Details

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.

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

get_by_title

def get_by_title(text, exact: nil)

Allows locating elements by their title attribute.

Usage

Consider the following DOM structure.

<span title='Issues count'>25 issues</span>

You can check the issues count after locating it by the title text:

page.get_by_title("Issues count").text_content # => "25 issues"

highlight

def highlight

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

hover

def hover(
      force: nil,
      modifiers: nil,
      noWaitAfter: nil,
      position: nil,
      timeout: nil,
      trial: nil)

Hover over the matching element.

Usage

page.get_by_role("link").hover

Details

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

Wait for actionability checks on the element, unless force option is set.
Scroll the element into view if needed.
Use Page#mouse to hover over the center of the element, or the specified position.

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.

inner_html

def inner_html(timeout: nil)

Returns the element.innerHTML.

inner_text

def inner_text(timeout: nil)

Returns the element.innerText.

NOTE: If you need to assert text on the page, prefer LocatorAssertions#to_have_text with useInnerText option to avoid flakiness. See assertions guide for more details.

input_value

def input_value(timeout: nil)

Returns the value for the matching <input> or <textarea> or <select> element.

NOTE: If you need to assert input value, prefer LocatorAssertions#to_have_value to avoid flakiness. See assertions guide for more details.

Usage

value = page.get_by_role("textbox").input_value

Details

Throws elements that are not an input, textarea or a select. However, if the element is inside the <label> element that has an associated control, returns the value of the control.

checked?

def checked?(timeout: nil)

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

NOTE: If you need to assert that checkbox is checked, prefer LocatorAssertions#to_be_checked to avoid flakiness. See assertions guide for more details.

Usage

checked = page.get_by_role("checkbox").checked?

disabled?

def disabled?(timeout: nil)

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

NOTE: If you need to assert that an element is disabled, prefer LocatorAssertions#to_be_disabled to avoid flakiness. See assertions guide for more details.

Usage

disabled = page.get_by_role("button").disabled?

editable?

def editable?(timeout: nil)

Returns whether the element is editable.

NOTE: If you need to assert that an element is editable, prefer LocatorAssertions#to_be_editable to avoid flakiness. See assertions guide for more details.

Usage

editable = page.get_by_role("textbox").editable?

enabled?

def enabled?(timeout: nil)

Returns whether the element is enabled.

NOTE: If you need to assert that an element is enabled, prefer LocatorAssertions#to_be_enabled to avoid flakiness. See assertions guide for more details.

Usage

enabled = page.get_by_role("button").enabled?

hidden?

def hidden?(timeout: nil)

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

NOTE: If you need to assert that element is hidden, prefer LocatorAssertions#to_be_hidden to avoid flakiness. See assertions guide for more details.

Usage

hidden = page.get_by_role("button").hidden?

visible?

def visible?(timeout: nil)

Returns whether the element is visible.

NOTE: If you need to assert that element is visible, prefer LocatorAssertions#to_be_visible to avoid flakiness. See assertions guide for more details.

Usage

visible = page.get_by_role("button").visible?

last

def last

Returns locator to the last matching element.

Usage

banana = page.get_by_role("listitem").last

locator

def locator(
      selectorOrLocator,
      has: nil,
      hasNot: nil,
      hasNotText: nil,
      hasText: nil)

The method finds an element matching the specified selector in the locator's subtree. It also accepts filter options, similar to Locator#filter method.

Learn more about locators.

nth

def nth(index)

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

Usage

banana = page.get_by_role("listitem").nth(2)

or

def or(locator)

Creates a locator matching all elements that match one or both of the two locators.

Note that when both locators match something, the resulting locator will have multiple matches and violate locator strictness guidelines.

Usage

Consider a scenario where you'd like to click on a "New email" button, but sometimes a security settings dialog shows up instead. In this case, you can wait for either a "New email" button, or a dialog and act accordingly.

new_email = page.get_by_role("button", name: "New")
dialog = page.get_by_text("Confirm security settings")
new_email.or(dialog).wait_for(state: 'visible')
if dialog.visible?
  page.get_by_role("button", name: "Dismiss").click
end
new_email.click

page

def page

A page this locator belongs to.

press

def press(key, delay: nil, noWaitAfter: nil, timeout: nil)

Focuses the matching element and presses a combination of the keys.

Usage

page.get_by_role("textbox").press("Backspace")

Details

Focuses the element, and then uses Keyboard#down and Keyboard#up.

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. ControlOrMeta resolves to Control on Windows and Linux and to Meta on macOS.

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.

press_sequentially

def press_sequentially(text, delay: nil, noWaitAfter: nil, timeout: nil)

NOTE: In most cases, you should use Locator#fill instead. You only need to press keys one by one if there is special keyboard handling on the page.

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.

Usage

element.press_sequentially("hello") # types instantly
element.press_sequentially("world", delay: 100) # types slower, like a user

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

element = page.get_by_label("Password")
element.press_sequentially("my password")
element.press("Enter")

screenshot

def screenshot(
      animations: nil,
      caret: nil,
      mask: nil,
      maskColor: nil,
      omitBackground: nil,
      path: nil,
      quality: nil,
      scale: nil,
      style: nil,
      timeout: nil,
      type: nil)

Take a screenshot of the element matching the locator.

Usage

page.get_by_role("link").screenshot

Disable animations and save screenshot to a file:

page.get_by_role("link").screenshot(animations="disabled", path="link.png")

Details

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.

scroll_into_view_if_needed

def scroll_into_view_if_needed(timeout: nil)

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

See scrolling for alternative ways to scroll.

select_option

def select_option(
      element: nil,
      index: nil,
      value: nil,
      label: nil,
      force: nil,
      noWaitAfter: nil,
      timeout: nil)

Selects option or options in <select>.

Details

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

<select multiple>
  <option value="red">Red</div>
  <option value="green">Green</div>
  <option value="blue">Blue</div>
</select>

# single selection matching the value or label
element.select_option(value: "blue")
# single selection matching both the label
element.select_option(label: "blue")
# multiple selection
element.select_option(value: ["red", "green", "blue"])

select_text

def select_text(force: nil, timeout: nil)

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.

set_checked

def set_checked(
      checked,
      force: nil,
      noWaitAfter: nil,
      position: nil,
      timeout: nil,
      trial: nil)

alias: checked=

Set the state of a checkbox or a radio element.

Usage

page.get_by_role("checkbox").checked = true
page.get_by_role("checkbox").set_checked(true)

Details

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

Ensure that matched element is a checkbox or a radio input. If not, this method throws.
If the element already has the right checked state, this method returns immediately.
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.
Scroll the element into view if needed.
Use Page#mouse to click in the center of the element.
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.

set_input_files

def set_input_files(files, noWaitAfter: nil, timeout: nil)

alias: input_files=

Upload file or multiple files into <input type=file>. For inputs with a [webkitdirectory] attribute, only a single directory path is supported.

Usage

# Select one file
page.get_by_label("Upload file").set_input_files('myfile.pdf')

# Select multiple files
page.get_by_label("Upload files").set_input_files(['file1.txt', 'file2.txt'])

# Select a directory
page.get_by_label("Upload directory").set_input_files('mydir')

# Remove all the selected files
page.get_by_label("Upload file").set_input_files([])

Details

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.

tap_point

def tap_point(
      force: nil,
      modifiers: nil,
      noWaitAfter: nil,
      position: nil,
      timeout: nil,
      trial: nil)

Perform a tap gesture on the element matching the locator.

Details

This method taps the element by performing the following steps:

Wait for actionability checks on the element, unless force option is set.
Scroll the element into view if needed.
Use Page#touchscreen to tap the center of the element, or the specified position.

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.

text_content

def text_content(timeout: nil)

Returns the node.textContent.

NOTE: If you need to assert text on the page, prefer LocatorAssertions#to_have_text to avoid flakiness. See assertions guide for more details.

type

def type(text, delay: nil, noWaitAfter: nil, timeout: nil)

warning

In most cases, you should use Locator#fill instead. You only need to press keys one by one if there is special keyboard handling on the page - in this case use Locator#press_sequentially.

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.

Usage

uncheck

def uncheck(
      force: nil,
      noWaitAfter: nil,
      position: nil,
      timeout: nil,
      trial: nil)

Ensure that checkbox or radio element is unchecked.

Usage

page.get_by_role("checkbox").uncheck

Details

This method unchecks the element by performing the following steps:

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.
Wait for actionability checks on the element, unless force option is set.
Scroll the element into view if needed.
Use Page#mouse to click in the center of the element.
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.

wait_for

def wait_for(state: nil, timeout: nil)

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.

Usage

order_sent = page.locator("#order-sent")
order_sent.wait_for

Locator

all​

all_inner_texts​

all_text_contents​

and​

aria_snapshot​

blur​

bounding_box​

check​

clear​

click​

count​

dblclick​

dispatch_event​

drag_to​

element_handle​

element_handles​

content_frame​

evaluate​

evaluate_all​

evaluate_handle​

fill​

filter​

first​

focus​

frame_locator​

get_attribute​

get_by_alt_text​

get_by_label​

get_by_placeholder​

get_by_role​

get_by_test_id​

get_by_text​

get_by_title​

highlight​

hover​

inner_html​

inner_text​

input_value​

checked?​

disabled?​

editable?​

enabled?​

hidden?​

visible?​

last​

locator​

nth​

or​

page​

press​

press_sequentially​

screenshot​

scroll_into_view_if_needed​

select_option​

select_text​

set_checked​

set_input_files​

tap_point​

text_content​

type​

uncheck​

wait_for​

all

all_inner_texts

all_text_contents

and

aria_snapshot

blur

bounding_box

check

clear

click

count

dblclick

dispatch_event

drag_to

element_handle

element_handles

content_frame

evaluate

evaluate_all

evaluate_handle

fill

filter

first

focus

frame_locator

get_attribute

get_by_alt_text

get_by_label

get_by_placeholder

get_by_role

get_by_test_id

get_by_text

get_by_title

highlight

hover

inner_html

inner_text

input_value

checked?

disabled?

editable?

enabled?

hidden?

visible?

last

locator

nth

or

page

press

press_sequentially

screenshot

scroll_into_view_if_needed

select_option

select_text

set_checked

set_input_files

tap_point

text_content

type

uncheck

wait_for