Class: Playwright::Locator

Inherits:
PlaywrightApi show all
Defined in:
lib/playwright_api/locator.rb,
sig/playwright.rbs

Overview

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 [method: Page.locator] method.

Learn more about locators.

Instance Method Summary collapse

Methods inherited from PlaywrightApi

#initialize, unwrap, wrap

Constructor Details

This class inherits a constructor from Playwright::PlaywrightApi

Instance Method Details

#_assertions(timeout, is_not, message) ⇒ Object 



1360
1361
1362
 
# File 'lib/playwright_api/locator.rb', line 1360

def _assertions(timeout, is_not, message)
  wrap_impl(@impl._assertions(unwrap_impl(timeout), unwrap_impl(is_not), unwrap_impl(message)))
end

#all ⇒ Array[untyped]

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

NOTE: [method: 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, [method: 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 [method: Locator.all].

Usage

for li in page.get_by_role('listitem').all():
  li.click();

Returns:

  • (Array[untyped]) 


24
25
26
 
# File 'lib/playwright_api/locator.rb', line 24

def all
  wrap_impl(@impl.all)
end

#all_inner_texts ⇒ Array[untyped]

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

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

Usage

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

Returns:

  • (Array[untyped]) 


38
39
40
 
# File 'lib/playwright_api/locator.rb', line 38

def all_inner_texts
  wrap_impl(@impl.all_inner_texts)
end

#all_text_contents ⇒ Array[untyped]

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

NOTE: If you need to assert text on the page, prefer [method: LocatorAssertions.toHaveText] to avoid flakiness. See assertions guide for more details.

Usage

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

Returns:

  • (Array[untyped]) 


52
53
54
 
# File 'lib/playwright_api/locator.rb', line 52

def all_text_contents
  wrap_impl(@impl.all_text_contents)
end

#and(locator) ⇒ 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"))

Parameters:

Returns:



66
67
68
 
# File 'lib/playwright_api/locator.rb', line 66

def and(locator)
  wrap_impl(@impl.and(unwrap_impl(locator)))
end

#aria_snapshot(boxes: nil, depth: nil, mode: nil, timeout: nil) ⇒ String

Captures the aria snapshot of the given element. Read more about aria snapshots and [method: LocatorAssertions.toMatchAriaSnapshot] 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"

An AI-optimized snapshot, controlled by mode, is different from a default snapshot:

  1. Includes element references [ref=e2]. 2. Does not wait for an element matching the locator, and throws when no elements match. 3. Includes snapshots of <iframe>s inside the target.

Parameters:

  • boxes: (Boolean) (defaults to: nil)
  • depth: (Integer) (defaults to: nil)
  • mode: ("ai", "default") (defaults to: nil)
  • timeout: (Float) (defaults to: nil)

Returns:

  • (String) 


109
110
111
 
# File 'lib/playwright_api/locator.rb', line 109

def aria_snapshot(boxes: nil, depth: nil, mode: nil, timeout: nil)
  wrap_impl(@impl.aria_snapshot(boxes: unwrap_impl(boxes), depth: unwrap_impl(depth), mode: unwrap_impl(mode), timeout: unwrap_impl(timeout)))
end

#blur(timeout: nil) ⇒ void

This method returns an undefined value.

Calls blur on the element.

Parameters:

  • timeout: (Float) (defaults to: nil) 


115
116
117
 
# File 'lib/playwright_api/locator.rb', line 115

def blur(timeout: nil)
  wrap_impl(@impl.blur(timeout: unwrap_impl(timeout)))
end

#bounding_box(timeout: nil) ⇒ nil, Hash[untyped, untyped]

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

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

Parameters:

  • timeout: (Float) (defaults to: nil)

Returns:

  • (nil, Hash[untyped, untyped]) 


141
142
143
 
# File 'lib/playwright_api/locator.rb', line 141

def bounding_box(timeout: nil)
  wrap_impl(@impl.bounding_box(timeout: unwrap_impl(timeout)))
end

#check(force: nil, noWaitAfter: nil, position: nil, scroll: nil, timeout: nil, trial: nil) ⇒ void

This method returns an undefined value.

Ensure that checkbox or radio element is checked.

Details

Performs 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 [property: Page.mouse] to click in the center of the element.
  5. 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()

Parameters:

  • force: (Boolean) (defaults to: nil)
  • noWaitAfter: (Boolean) (defaults to: nil)
  • position: (Hash[untyped, untyped]) (defaults to: nil)
  • scroll: ("auto", "none") (defaults to: nil)
  • timeout: (Float) (defaults to: nil)
  • trial: (Boolean) (defaults to: nil) 


167
168
169
170
171
172
173
174
175
 
# File 'lib/playwright_api/locator.rb', line 167

def check(
      force: nil,
      noWaitAfter: nil,
      position: nil,
      scroll: nil,
      timeout: nil,
      trial: nil)
  wrap_impl(@impl.check(force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), scroll: unwrap_impl(scroll), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end

#checked?(timeout: nil) ⇒ Boolean

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 [method: LocatorAssertions.toBeChecked] to avoid flakiness. See assertions guide for more details.

Usage

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

Parameters:

  • timeout: (Float) (defaults to: nil)

Returns:

  • (Boolean) 


862
863
864
 
# File 'lib/playwright_api/locator.rb', line 862

def checked?(timeout: nil)
  wrap_impl(@impl.checked?(timeout: unwrap_impl(timeout)))
end

#clear(force: nil, noWaitAfter: nil, timeout: nil) ⇒ void

This method returns an undefined value.

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

Parameters:

  • force: (Boolean) (defaults to: nil)
  • noWaitAfter: (Boolean) (defaults to: nil)
  • timeout: (Float) (defaults to: nil) 


191
192
193
 
# File 'lib/playwright_api/locator.rb', line 191

def clear(force: nil, noWaitAfter: nil, timeout: nil)
  wrap_impl(@impl.clear(force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
end

#click(button: nil, clickCount: nil, delay: nil, force: nil, modifiers: nil, noWaitAfter: nil, position: nil, scroll: nil, steps: nil, timeout: nil, trial: nil) ⇒ void

This method returns an undefined value.

Click an element.

Details

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 [property: 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.

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}
)

Parameters:

  • button: ("left", "right", "middle") (defaults to: nil)
  • clickCount: (Integer) (defaults to: nil)
  • delay: (Float) (defaults to: nil)
  • force: (Boolean) (defaults to: nil)
  • modifiers: (Array[untyped]) (defaults to: nil)
  • noWaitAfter: (Boolean) (defaults to: nil)
  • position: (Hash[untyped, untyped]) (defaults to: nil)
  • scroll: ("auto", "none") (defaults to: nil)
  • steps: (Integer) (defaults to: nil)
  • timeout: (Float) (defaults to: nil)
  • trial: (Boolean) (defaults to: nil) 


226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/playwright_api/locator.rb', line 226

def click(
      button: nil,
      clickCount: nil,
      delay: nil,
      force: nil,
      modifiers: nil,
      noWaitAfter: nil,
      position: nil,
      scroll: nil,
      steps: nil,
      timeout: nil,
      trial: nil)
  wrap_impl(@impl.click(button: unwrap_impl(button), clickCount: unwrap_impl(clickCount), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), scroll: unwrap_impl(scroll), steps: unwrap_impl(steps), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end

#content_frame ⇒ FrameLocator

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 [method: FrameLocator.owner].

Usage

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

Returns:



442
443
444
 
# File 'lib/playwright_api/locator.rb', line 442

def content_frame
  wrap_impl(@impl.content_frame)
end

#count ⇒ Integer

Returns the number of elements matching the locator.

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

Usage

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

Returns:

  • (Integer) 


251
252
253
 
# File 'lib/playwright_api/locator.rb', line 251

def count
  wrap_impl(@impl.count)
end

#dblclick(button: nil, delay: nil, force: nil, modifiers: nil, noWaitAfter: nil, position: nil, scroll: nil, steps: nil, timeout: nil, trial: nil) ⇒ void

This method returns an undefined value.

Double-click an element.

Details

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 [property: 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.

Parameters:

  • button: ("left", "right", "middle") (defaults to: nil)
  • delay: (Float) (defaults to: nil)
  • force: (Boolean) (defaults to: nil)
  • modifiers: (Array[untyped]) (defaults to: nil)
  • noWaitAfter: (Boolean) (defaults to: nil)
  • position: (Hash[untyped, untyped]) (defaults to: nil)
  • scroll: ("auto", "none") (defaults to: nil)
  • steps: (Integer) (defaults to: nil)
  • timeout: (Float) (defaults to: nil)
  • trial: (Boolean) (defaults to: nil) 


271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/playwright_api/locator.rb', line 271

def dblclick(
      button: nil,
      delay: nil,
      force: nil,
      modifiers: nil,
      noWaitAfter: nil,
      position: nil,
      scroll: nil,
      steps: nil,
      timeout: nil,
      trial: nil)
  wrap_impl(@impl.dblclick(button: unwrap_impl(button), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), scroll: unwrap_impl(scroll), steps: unwrap_impl(steps), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end

#describe(description) ⇒ Locator

Describes the locator, description is used in the trace viewer and reports. Returns the locator pointing to the same element.

Usage

button = page.get_by_test_id("btn-sub").describe("Subscribe button")
button.click()

Parameters:

  • description (String)

Returns:



295
296
297
 
# File 'lib/playwright_api/locator.rb', line 295

def describe(description)
  wrap_impl(@impl.describe(unwrap_impl(description)))
end

#description ⇒ nil, String

Returns locator description previously set with [method: Locator.describe]. Returns null if no custom description has been set.

Usage

button = page.get_by_role("button").describe("Subscribe button")
print(button.description())  # "Subscribe button"

input = page.get_by_role("textbox")
print(input.description())  # None

Returns:

  • (nil, String) 


311
312
313
 
# File 'lib/playwright_api/locator.rb', line 311

def description
  wrap_impl(@impl.description)
end

#disabled?(timeout: nil) ⇒ Boolean

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

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

Usage

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

Parameters:

  • timeout: (Float) (defaults to: nil)

Returns:

  • (Boolean) 


876
877
878
 
# File 'lib/playwright_api/locator.rb', line 876

def disabled?(timeout: nil)
  wrap_impl(@impl.disabled?(timeout: unwrap_impl(timeout)))
end

#dispatch_event(type, eventInit: nil, timeout: nil) ⇒ void

This method returns an undefined value.

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:

data_transfer = page.evaluate_handle("new DataTransfer()")
locator.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})

Parameters:

  • type_ (String)
  • eventInit: (Object) (defaults to: nil)
  • timeout: (Float) (defaults to: nil) 


353
354
355
 
# File 'lib/playwright_api/locator.rb', line 353

def dispatch_event(type, eventInit: nil, timeout: nil)
  wrap_impl(@impl.dispatch_event(unwrap_impl(type), eventInit: unwrap_impl(eventInit), timeout: unwrap_impl(timeout)))
end

#drag_to(target, force: nil, noWaitAfter: nil, scroll: nil, sourcePosition: nil, steps: nil, targetPosition: nil, timeout: nil, trial: nil) ⇒ void

This method returns an undefined value.

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,
  source_position={"x": 34, "y": 7},
  target_position={"x": 10, "y": 20}
)

Parameters:

  • target (Locator)
  • force: (Boolean) (defaults to: nil)
  • noWaitAfter: (Boolean) (defaults to: nil)
  • scroll: ("auto", "none") (defaults to: nil)
  • sourcePosition: (Hash[untyped, untyped]) (defaults to: nil)
  • steps: (Integer) (defaults to: nil)
  • targetPosition: (Hash[untyped, untyped]) (defaults to: nil)
  • timeout: (Float) (defaults to: nil)
  • trial: (Boolean) (defaults to: nil) 


380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/playwright_api/locator.rb', line 380

def drag_to(
      target,
      force: nil,
      noWaitAfter: nil,
      scroll: nil,
      sourcePosition: nil,
      steps: nil,
      targetPosition: nil,
      timeout: nil,
      trial: nil)
  wrap_impl(@impl.drag_to(unwrap_impl(target), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), scroll: unwrap_impl(scroll), sourcePosition: unwrap_impl(sourcePosition), steps: unwrap_impl(steps), targetPosition: unwrap_impl(targetPosition), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end

#drop(payload, position: nil, timeout: nil) ⇒ void

This method returns an undefined value.

Simulate an external drag-and-drop of files or clipboard-like data onto this locator.

Details

Dispatches the native dragenter, dragover, and drop events at the center of the target element with a synthetic [DataTransfer] carrying the provided files and/or data entries. Works cross-browser by constructing the [DataTransfer] in the page context.

If the target element's dragover listener does not call preventDefault(), the target is considered to have rejected the drop: Playwright dispatches dragleave and this method throws.

Usage

Drop a file buffer onto an upload area:

Drop plain text and a URL together:

Parameters:

  • payload (Hash[untyped, untyped])
  • position: (Hash[untyped, untyped]) (defaults to: nil)
  • timeout: (Float) (defaults to: nil) 


411
412
413
 
# File 'lib/playwright_api/locator.rb', line 411

def drop(payload, position: nil, timeout: nil)
  wrap_impl(@impl.drop(unwrap_impl(payload), position: unwrap_impl(position), timeout: unwrap_impl(timeout)))
end

#editable?(timeout: nil) ⇒ Boolean

Returns whether the element is editable. If the target element is not an <input>, <textarea>, <select>, [contenteditable] and does not have a role allowing [aria-readonly], this method throws an error.

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

Usage

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

Parameters:

  • timeout: (Float) (defaults to: nil)

Returns:

  • (Boolean) 


890
891
892
 
# File 'lib/playwright_api/locator.rb', line 890

def editable?(timeout: nil)
  wrap_impl(@impl.editable?(timeout: unwrap_impl(timeout)))
end

#element_handle(timeout: nil) ⇒ ElementHandle

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.

Parameters:

  • timeout: (Float) (defaults to: nil)

Returns:



417
418
419
 
# File 'lib/playwright_api/locator.rb', line 417

def element_handle(timeout: nil)
  wrap_impl(@impl.element_handle(timeout: unwrap_impl(timeout)))
end

#element_handles ⇒ Array[untyped]

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

Returns:

  • (Array[untyped]) 


423
424
425
 
# File 'lib/playwright_api/locator.rb', line 423

def element_handles
  wrap_impl(@impl.element_handles)
end

#enabled?(timeout: nil) ⇒ Boolean

Returns whether the element is enabled.

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

Usage

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

Parameters:

  • timeout: (Float) (defaults to: nil)

Returns:

  • (Boolean) 


904
905
906
 
# File 'lib/playwright_api/locator.rb', line 904

def enabled?(timeout: nil)
  wrap_impl(@impl.enabled?(timeout: unwrap_impl(timeout)))
end

#evaluate(expression, arg: nil, timeout: nil) ⇒ Object

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

Passing argument to expression:

result = page.get_by_testid("myId").evaluate("(element, [x, y]) => element.textContent + ' ' + x * y", [7, 8])
print(result) # prints "myId text 56"

Parameters:

  • expression (String)
  • arg: (Object) (defaults to: nil)
  • timeout: (Float) (defaults to: nil)

Returns:

  • (Object) 


465
466
467
 
# File 'lib/playwright_api/locator.rb', line 465

def evaluate(expression, arg: nil, timeout: nil)
  wrap_impl(@impl.evaluate(unwrap_impl(expression), arg: unwrap_impl(arg), timeout: unwrap_impl(timeout)))
end

#evaluate_all(expression, arg: nil) ⇒ Object

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", 10)

Parameters:

  • expression (String)
  • arg: (Object) (defaults to: nil)

Returns:

  • (Object) 


486
487
488
 
# File 'lib/playwright_api/locator.rb', line 486

def evaluate_all(expression, arg: nil)
  wrap_impl(@impl.evaluate_all(unwrap_impl(expression), arg: unwrap_impl(arg)))
end

#evaluate_handle(expression, arg: nil, timeout: nil) ⇒ JSHandle

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 [method: Locator.evaluate] and [method: Locator.evaluateHandle] is that [method: Locator.evaluateHandle] 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 [method: Page.evaluateHandle] for more details.

Parameters:

  • expression (String)
  • arg: (Object) (defaults to: nil)
  • timeout: (Float) (defaults to: nil)

Returns:



504
505
506
 
# File 'lib/playwright_api/locator.rb', line 504

def evaluate_handle(expression, arg: nil, timeout: nil)
  wrap_impl(@impl.evaluate_handle(unwrap_impl(expression), arg: unwrap_impl(arg), timeout: unwrap_impl(timeout)))
end

#expect(expression, options, title) ⇒ Object 



1355
1356
1357
 
# File 'lib/playwright_api/locator.rb', line 1355

def expect(expression, options, title)
  wrap_impl(@impl.expect(unwrap_impl(expression), unwrap_impl(options), unwrap_impl(title)))
end

#fill(value, force: nil, noWaitAfter: nil, timeout: nil) ⇒ void

This method returns an undefined value.

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.

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 [method: Locator.pressSequentially].

Parameters:

  • value (String)
  • force: (Boolean) (defaults to: nil)
  • noWaitAfter: (Boolean) (defaults to: nil)
  • timeout: (Float) (defaults to: nil) 


524
525
526
 
# File 'lib/playwright_api/locator.rb', line 524

def fill(value, force: nil, noWaitAfter: nil, timeout: nil)
  wrap_impl(@impl.fill(unwrap_impl(value), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
end

#filter(has: nil, hasNot: nil, hasNotText: nil, hasText: nil, visible: nil) ⇒ Locator

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(has_text="text in column 1").filter(
    has=page.get_by_role("button", name="column 2 button")
).screenshot()

Parameters:

  • has: (Locator) (defaults to: nil)
  • hasNot: (Locator) (defaults to: nil)
  • hasNotText: (String, Regexp) (defaults to: nil)
  • hasText: (String, Regexp) (defaults to: nil)
  • visible: (Boolean) (defaults to: nil)

Returns:



541
542
543
544
545
546
547
548
 
# File 'lib/playwright_api/locator.rb', line 541

def filter(
      has: nil,
      hasNot: nil,
      hasNotText: nil,
      hasText: nil,
      visible: nil)
  wrap_impl(@impl.filter(has: unwrap_impl(has), hasNot: unwrap_impl(hasNot), hasNotText: unwrap_impl(hasNotText), hasText: unwrap_impl(hasText), visible: unwrap_impl(visible)))
end

#first ⇒ Locator

Returns locator to the first matching element.

Returns:



552
553
554
 
# File 'lib/playwright_api/locator.rb', line 552

def first
  wrap_impl(@impl.first)
end

#focus(timeout: nil) ⇒ void

This method returns an undefined value.

Calls focus on the matching element.

Parameters:

  • timeout: (Float) (defaults to: nil) 


558
559
560
 
# File 'lib/playwright_api/locator.rb', line 558

def focus(timeout: nil)
  wrap_impl(@impl.focus(timeout: unwrap_impl(timeout)))
end

#frame_locator(selector) ⇒ FrameLocator

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

Parameters:

  • selector (String)

Returns:



572
573
574
 
# File 'lib/playwright_api/locator.rb', line 572

def frame_locator(selector)
  wrap_impl(@impl.frame_locator(unwrap_impl(selector)))
end

#get_attribute(name, timeout: nil) ⇒ nil, String Also known as: []

Returns the matching element's attribute value.

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

Parameters:

  • name (String)
  • timeout: (Float) (defaults to: nil)

Returns:

  • (nil, String) 


580
581
582
 
# File 'lib/playwright_api/locator.rb', line 580

def get_attribute(name, timeout: nil)
  wrap_impl(@impl.get_attribute(unwrap_impl(name), timeout: unwrap_impl(timeout)))
end

#get_by_alt_text(text, exact: nil) ⇒ Locator

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

Parameters:

  • text (String, Regexp)
  • exact: (Boolean) (defaults to: nil)

Returns:



599
600
601
 
# File 'lib/playwright_api/locator.rb', line 599

def get_by_alt_text(text, exact: nil)
  wrap_impl(@impl.get_by_alt_text(unwrap_impl(text), exact: unwrap_impl(exact)))
end

#get_by_label(text, exact: nil) ⇒ Locator

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

Parameters:

  • text (String, Regexp)
  • exact: (Boolean) (defaults to: nil)

Returns:



620
621
622
 
# File 'lib/playwright_api/locator.rb', line 620

def get_by_label(text, exact: nil)
  wrap_impl(@impl.get_by_label(unwrap_impl(text), exact: unwrap_impl(exact)))
end

#get_by_placeholder(text, exact: nil) ⇒ Locator

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

Parameters:

  • text (String, Regexp)
  • exact: (Boolean) (defaults to: nil)

Returns:



640
641
642
 
# File 'lib/playwright_api/locator.rb', line 640

def get_by_placeholder(text, exact: nil)
  wrap_impl(@impl.get_by_placeholder(unwrap_impl(text), exact: unwrap_impl(exact)))
end

#get_by_role(role, checked: nil, description: nil, disabled: nil, exact: nil, expanded: nil, includeHidden: nil, level: nil, name: nil, pressed: nil, selected: nil) ⇒ Locator

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 its implicit role:

expect(page.get_by_role("heading", name="Sign up")).to_be_visible()

page.get_by_role("checkbox", name="Subscribe").check()

page.get_by_role("button", name=re.compile("submit", re.IGNORECASE)).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.

Parameters:

  • 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")
  • checked: (Boolean) (defaults to: nil)
  • description: (String, Regexp) (defaults to: nil)
  • disabled: (Boolean) (defaults to: nil)
  • exact: (Boolean) (defaults to: nil)
  • expanded: (Boolean) (defaults to: nil)
  • includeHidden: (Boolean) (defaults to: nil)
  • level: (Integer) (defaults to: nil)
  • name: (String, Regexp) (defaults to: nil)
  • pressed: (Boolean) (defaults to: nil)
  • selected: (Boolean) (defaults to: nil)

Returns:



675
676
677
678
679
680
681
682
683
684
685
686
687
688
 
# File 'lib/playwright_api/locator.rb', line 675

def get_by_role(
      role,
      checked: nil,
      description: nil,
      disabled: nil,
      exact: nil,
      expanded: nil,
      includeHidden: nil,
      level: nil,
      name: nil,
      pressed: nil,
      selected: nil)
  wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), description: unwrap_impl(description), disabled: unwrap_impl(disabled), exact: unwrap_impl(exact), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
end

#get_by_test_id(testId) ⇒ Locator Also known as: get_by_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 its test id:

page.get_by_test_id("directions").click()

Details

By default, the data-testid attribute is used as a test id. Use [method: Selectors.setTestIdAttribute] to configure a different test id attribute if necessary.

Parameters:

  • testId (String, Regexp)

Returns:



710
711
712
 
# File 'lib/playwright_api/locator.rb', line 710

def get_by_test_id(testId)
  wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
end

#get_by_text(text, exact: nil) ⇒ Locator

Allows locating elements that contain given text.

See also [method: 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:

# Matches <span>
page.get_by_text("world")

# Matches first <div>
page.get_by_text("Hello world")

# Matches second <div>
page.get_by_text("Hello", exact=True)

# Matches both <div>s
page.get_by_text(re.compile("Hello"))

# Matches second <div>
page.get_by_text(re.compile("^hello$", re.IGNORECASE))

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

Parameters:

  • text (String, Regexp)
  • exact: (Boolean) (defaults to: nil)

Returns:



753
754
755
 
# File 'lib/playwright_api/locator.rb', line 753

def get_by_text(text, exact: nil)
  wrap_impl(@impl.get_by_text(unwrap_impl(text), exact: unwrap_impl(exact)))
end

#get_by_title(text, exact: nil) ⇒ Locator

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:

expect(page.get_by_title("Issues count")).to_have_text("25 issues")

Parameters:

  • text (String, Regexp)
  • exact: (Boolean) (defaults to: nil)

Returns:



773
774
775
 
# File 'lib/playwright_api/locator.rb', line 773

def get_by_title(text, exact: nil)
  wrap_impl(@impl.get_by_title(unwrap_impl(text), exact: unwrap_impl(exact)))
end

#hidden?(timeout: nil) ⇒ Boolean

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

NOTE: If you need to assert that element is hidden, prefer [method: LocatorAssertions.toBeHidden] to avoid flakiness. See assertions guide for more details.

Usage

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

Parameters:

  • timeout: (Float) (defaults to: nil)

Returns:

  • (Boolean) 


918
919
920
 
# File 'lib/playwright_api/locator.rb', line 918

def hidden?(timeout: nil)
  wrap_impl(@impl.hidden?(timeout: unwrap_impl(timeout)))
end

#hide_highlight ⇒ void

This method returns an undefined value.

Hides the element highlight previously added by [method: Locator.highlight].



779
780
781
 
# File 'lib/playwright_api/locator.rb', line 779

def hide_highlight
  wrap_impl(@impl.hide_highlight)
end

#highlight(style: nil) ⇒ Object

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

Parameters:

  • style: (String) (defaults to: nil)

Returns:

  • (Object) 


785
786
787
 
# File 'lib/playwright_api/locator.rb', line 785

def highlight(style: nil)
  wrap_impl(@impl.highlight(style: unwrap_impl(style)))
end

#hover(force: nil, modifiers: nil, noWaitAfter: nil, position: nil, scroll: nil, timeout: nil, trial: nil) ⇒ void

This method returns an undefined value.

Hover over the matching element.

Usage

page.get_by_role("link").hover()

Details

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 [property: 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.

Parameters:

  • force: (Boolean) (defaults to: nil)
  • modifiers: (Array[untyped]) (defaults to: nil)
  • noWaitAfter: (Boolean) (defaults to: nil)
  • position: (Hash[untyped, untyped]) (defaults to: nil)
  • scroll: ("auto", "none") (defaults to: nil)
  • timeout: (Float) (defaults to: nil)
  • trial: (Boolean) (defaults to: nil) 


809
810
811
812
813
814
815
816
817
818
 
# File 'lib/playwright_api/locator.rb', line 809

def hover(
      force: nil,
      modifiers: nil,
      noWaitAfter: nil,
      position: nil,
      scroll: nil,
      timeout: nil,
      trial: nil)
  wrap_impl(@impl.hover(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), scroll: unwrap_impl(scroll), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end

#inner_html(timeout: nil) ⇒ String

Returns the element.innerHTML.

Parameters:

  • timeout: (Float) (defaults to: nil)

Returns:

  • (String) 


822
823
824
 
# File 'lib/playwright_api/locator.rb', line 822

def inner_html(timeout: nil)
  wrap_impl(@impl.inner_html(timeout: unwrap_impl(timeout)))
end

#inner_text(timeout: nil) ⇒ String

Returns the element.innerText.

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

Parameters:

  • timeout: (Float) (defaults to: nil)

Returns:

  • (String) 


830
831
832
 
# File 'lib/playwright_api/locator.rb', line 830

def inner_text(timeout: nil)
  wrap_impl(@impl.inner_text(timeout: unwrap_impl(timeout)))
end

#input_value(timeout: nil) ⇒ String

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

NOTE: If you need to assert input value, prefer [method: LocatorAssertions.toHaveValue] 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.

Parameters:

  • timeout: (Float) (defaults to: nil)

Returns:

  • (String) 


848
849
850
 
# File 'lib/playwright_api/locator.rb', line 848

def input_value(timeout: nil)
  wrap_impl(@impl.input_value(timeout: unwrap_impl(timeout)))
end

#last ⇒ Locator

Returns locator to the last matching element.

Usage

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

Returns:



944
945
946
 
# File 'lib/playwright_api/locator.rb', line 944

def last
  wrap_impl(@impl.last)
end

#locator(selectorOrLocator, has: nil, hasNot: nil, hasNotText: nil, hasText: nil) ⇒ Locator

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

Learn more about locators.

Parameters:

  • selectorOrLocator (String, Locator)
  • has: (Locator) (defaults to: nil)
  • hasNot: (Locator) (defaults to: nil)
  • hasNotText: (String, Regexp) (defaults to: nil)
  • hasText: (String, Regexp) (defaults to: nil)

Returns:



952
953
954
955
956
957
958
959
 
# File 'lib/playwright_api/locator.rb', line 952

def locator(
      selectorOrLocator,
      has: nil,
      hasNot: nil,
      hasNotText: nil,
      hasText: nil)
  wrap_impl(@impl.locator(unwrap_impl(selectorOrLocator), has: unwrap_impl(has), hasNot: unwrap_impl(hasNot), hasNotText: unwrap_impl(hasNotText), hasText: unwrap_impl(hasText)))
end

#normalize ⇒ Locator

Returns a new locator that uses best practices for referencing the matched element, prioritizing test ids, aria roles, and other user-facing attributes over CSS selectors. This is useful for converting implementation-detail selectors into more resilient, human-readable locators.

Returns:



964
965
966
 
# File 'lib/playwright_api/locator.rb', line 964

def normalize
  wrap_impl(@impl.normalize)
end

#nth(index) ⇒ Locator

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)

Parameters:

  • index (Integer)

Returns:



976
977
978
 
# File 'lib/playwright_api/locator.rb', line 976

def nth(index)
  wrap_impl(@impl.nth(unwrap_impl(index)))
end

#or(locator) ⇒ 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, potentially causing a locator strictness violation.

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.

NOTE: If both "New email" button and security dialog appear on screen, the "or" locator will match both of them, possibly throwing the "strict mode violation" error. In this case, you can use [method: Locator.first] to only match one of them.

new_email = page.get_by_role("button", name="New")
dialog = page.get_by_text("Confirm security settings")
expect(new_email.or_(dialog).first).to_be_visible()
if (dialog.is_visible()):
  page.get_by_role("button", name="Dismiss").click()
new_email.click()

Parameters:

Returns:



1000
1001
1002
 
# File 'lib/playwright_api/locator.rb', line 1000

def or(locator)
  wrap_impl(@impl.or(unwrap_impl(locator)))
end

#page ⇒ Page

A page this locator belongs to.

Returns:



1006
1007
1008
 
# File 'lib/playwright_api/locator.rb', line 1006

def page
  wrap_impl(@impl.page)
end

#press(key, delay: nil, noWaitAfter: nil, timeout: nil) ⇒ void

This method returns an undefined value.

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 [method: Keyboard.down] and [method: 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.

Parameters:

  • key (String)
  • delay: (Float) (defaults to: nil)
  • noWaitAfter: (Boolean) (defaults to: nil)
  • timeout: (Float) (defaults to: nil) 


1041
1042
1043
 
# File 'lib/playwright_api/locator.rb', line 1041

def press(key, delay: nil, noWaitAfter: nil, timeout: nil)
  wrap_impl(@impl.press(unwrap_impl(key), delay: unwrap_impl(delay), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
end

#press_sequentially(text, delay: nil, noWaitAfter: nil, timeout: nil) ⇒ void

This method returns an undefined value.

NOTE: In most cases, you should use [method: 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 [method: Locator.press].

Usage

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

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

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

Parameters:

  • text (String)
  • delay: (Float) (defaults to: nil)
  • noWaitAfter: (Boolean) (defaults to: nil)
  • timeout: (Float) (defaults to: nil) 


1066
1067
1068
 
# File 'lib/playwright_api/locator.rb', line 1066

def press_sequentially(text, delay: nil, noWaitAfter: nil, timeout: nil)
  wrap_impl(@impl.press_sequentially(unwrap_impl(text), delay: unwrap_impl(delay), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
end

#resolve_selector ⇒ Object 



1365
1366
1367
 
# File 'lib/playwright_api/locator.rb', line 1365

def resolve_selector
  wrap_impl(@impl.resolve_selector)
end

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

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.

Parameters:

  • animations: ("disabled", "allow") (defaults to: nil)
  • caret: ("hide", "initial") (defaults to: nil)
  • mask: (Array[untyped]) (defaults to: nil)
  • maskColor: (String) (defaults to: nil)
  • omitBackground: (Boolean) (defaults to: nil)
  • path: (String, File) (defaults to: nil)
  • quality: (Integer) (defaults to: nil)
  • scale: ("css", "device") (defaults to: nil)
  • style: (String) (defaults to: nil)
  • timeout: (Float) (defaults to: nil)
  • type: ("png", "jpeg", "webp") (defaults to: nil)

Returns:

  • (String) 


1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'lib/playwright_api/locator.rb', line 1093

def screenshot(
      animations: nil,
      caret: nil,
      mask: nil,
      maskColor: nil,
      omitBackground: nil,
      path: nil,
      quality: nil,
      scale: nil,
      style: nil,
      timeout: nil,
      type: nil)
  wrap_impl(@impl.screenshot(animations: unwrap_impl(animations), caret: unwrap_impl(caret), mask: unwrap_impl(mask), maskColor: unwrap_impl(maskColor), omitBackground: unwrap_impl(omitBackground), path: unwrap_impl(path), quality: unwrap_impl(quality), scale: unwrap_impl(scale), style: unwrap_impl(style), timeout: unwrap_impl(timeout), type: unwrap_impl(type)))
end

#scroll_into_view_if_needed(timeout: nil) ⇒ void

This method returns an undefined value.

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.

Parameters:

  • timeout: (Float) (defaults to: nil) 


1114
1115
1116
 
# File 'lib/playwright_api/locator.rb', line 1114

def scroll_into_view_if_needed(timeout: nil)
  wrap_impl(@impl.scroll_into_view_if_needed(timeout: unwrap_impl(timeout)))
end

#select_option(element: nil, index: nil, value: nil, label: nil, force: nil, noWaitAfter: nil, timeout: nil) ⇒ Array[untyped]

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</option>
  <option value="green">Green</option>
  <option value="blue">Blue</option>
</select>

# single selection matching the value or label
element.select_option("blue")
# single selection matching the label
element.select_option(label="blue")
# multiple selection for blue, red and second option
element.select_option(value=["red", "green", "blue"])

Parameters:

  • element: (ElementHandle, Array[untyped]) (defaults to: nil)
  • index: (Integer, Array[untyped]) (defaults to: nil)
  • value: (String, Array[untyped]) (defaults to: nil)
  • label: (String, Array[untyped]) (defaults to: nil)
  • force: (Boolean) (defaults to: nil)
  • noWaitAfter: (Boolean) (defaults to: nil)
  • timeout: (Float) (defaults to: nil)

Returns:

  • (Array[untyped]) 


1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
 
# File 'lib/playwright_api/locator.rb', line 1149

def select_option(
      element: nil,
      index: nil,
      value: nil,
      label: nil,
      force: nil,
      noWaitAfter: nil,
      timeout: nil)
  wrap_impl(@impl.select_option(element: unwrap_impl(element), index: unwrap_impl(index), value: unwrap_impl(value), label: unwrap_impl(label), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
end

#select_text(force: nil, timeout: nil) ⇒ void

This method returns an undefined value.

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.

Parameters:

  • force: (Boolean) (defaults to: nil)
  • timeout: (Float) (defaults to: nil) 


1165
1166
1167
 
# File 'lib/playwright_api/locator.rb', line 1165

def select_text(force: nil, timeout: nil)
  wrap_impl(@impl.select_text(force: unwrap_impl(force), timeout: unwrap_impl(timeout)))
end

#set_checked(checked, force: nil, noWaitAfter: nil, position: nil, scroll: nil, timeout: nil, trial: nil) ⇒ void Also known as: checked=

This method returns an undefined value.

Set the state of a checkbox or a radio element.

Usage

page.get_by_role("checkbox").set_checked(True)

Details

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 [property: Page.mouse] to click in the center of the element.
  6. 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.

Parameters:

  • checked (Boolean)
  • force: (Boolean) (defaults to: nil)
  • noWaitAfter: (Boolean) (defaults to: nil)
  • position: (Hash[untyped, untyped]) (defaults to: nil)
  • scroll: ("auto", "none") (defaults to: nil)
  • timeout: (Float) (defaults to: nil)
  • trial: (Boolean) (defaults to: nil) 


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'lib/playwright_api/locator.rb', line 1190

def set_checked(
      checked,
      force: nil,
      noWaitAfter: nil,
      position: nil,
      scroll: nil,
      timeout: nil,
      trial: nil)
  wrap_impl(@impl.set_checked(unwrap_impl(checked), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), scroll: unwrap_impl(scroll), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end

#set_input_files(files, noWaitAfter: nil, timeout: nil) ⇒ void Also known as: input_files=

This method returns an undefined value.

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([])

# Upload buffer from memory
page.get_by_label("Upload file").set_input_files(
    files=[
        {"name": "test.txt", "mimeType": "text/plain", "buffer": b"this is a test"}
    ],
)

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.

Parameters:

  • files ((String | File), Array[untyped], Hash[untyped, untyped], Array[untyped])
  • noWaitAfter: (Boolean) (defaults to: nil)
  • timeout: (Float) (defaults to: nil) 


1236
1237
1238
 
# File 'lib/playwright_api/locator.rb', line 1236

def set_input_files(files, noWaitAfter: nil, timeout: nil)
  wrap_impl(@impl.set_input_files(unwrap_impl(files), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
end

#tap_point(force: nil, modifiers: nil, noWaitAfter: nil, position: nil, scroll: nil, timeout: nil, trial: nil) ⇒ void

This method returns an undefined value.

Perform a tap gesture on the element matching the locator. For examples of emulating other gestures by manually dispatching touch events, see the emulating legacy touch events page.

Details

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 [property: 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.

Parameters:

  • force: (Boolean) (defaults to: nil)
  • modifiers: (Array[untyped]) (defaults to: nil)
  • noWaitAfter: (Boolean) (defaults to: nil)
  • position: (Hash[untyped, untyped]) (defaults to: nil)
  • scroll: ("auto", "none") (defaults to: nil)
  • timeout: (Float) (defaults to: nil)
  • trial: (Boolean) (defaults to: nil) 


1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'lib/playwright_api/locator.rb', line 1257

def tap_point(
      force: nil,
      modifiers: nil,
      noWaitAfter: nil,
      position: nil,
      scroll: nil,
      timeout: nil,
      trial: nil)
  wrap_impl(@impl.tap_point(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), scroll: unwrap_impl(scroll), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end

#text_content(timeout: nil) ⇒ nil, String

Returns the node.textContent.

NOTE: If you need to assert text on the page, prefer [method: LocatorAssertions.toHaveText] to avoid flakiness. See assertions guide for more details.

Parameters:

  • timeout: (Float) (defaults to: nil)

Returns:

  • (nil, String) 


1272
1273
1274
 
# File 'lib/playwright_api/locator.rb', line 1272

def text_content(timeout: nil)
  wrap_impl(@impl.text_content(timeout: unwrap_impl(timeout)))
end

#to_s ⇒ Object 



1370
1371
1372
 
# File 'lib/playwright_api/locator.rb', line 1370

def to_s
  wrap_impl(@impl.to_s)
end

#type(text, delay: nil, noWaitAfter: nil, timeout: nil) ⇒ void

Deprecated.

In most cases, you should use [method: 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 [method: Locator.pressSequentially].

This method returns an undefined value.

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 [method: Locator.press].

Usage

Parameters:

  • text (String)
  • delay: (Float) (defaults to: nil)
  • noWaitAfter: (Boolean) (defaults to: nil)
  • timeout: (Float) (defaults to: nil) 


1284
1285
1286
 
# File 'lib/playwright_api/locator.rb', line 1284

def type(text, delay: nil, noWaitAfter: nil, timeout: nil)
  wrap_impl(@impl.type(unwrap_impl(text), delay: unwrap_impl(delay), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
end

#uncheck(force: nil, noWaitAfter: nil, position: nil, scroll: nil, timeout: nil, trial: nil) ⇒ void

This method returns an undefined value.

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:

  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 [property: Page.mouse] to click in the center of the element.
  5. 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.

Parameters:

  • force: (Boolean) (defaults to: nil)
  • noWaitAfter: (Boolean) (defaults to: nil)
  • position: (Hash[untyped, untyped]) (defaults to: nil)
  • scroll: ("auto", "none") (defaults to: nil)
  • timeout: (Float) (defaults to: nil)
  • trial: (Boolean) (defaults to: nil) 


1310
1311
1312
1313
1314
1315
1316
1317
1318
 
# File 'lib/playwright_api/locator.rb', line 1310

def uncheck(
      force: nil,
      noWaitAfter: nil,
      position: nil,
      scroll: nil,
      timeout: nil,
      trial: nil)
  wrap_impl(@impl.uncheck(force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), scroll: unwrap_impl(scroll), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end

#visible?(timeout: nil) ⇒ Boolean

Returns whether the element is visible.

NOTE: If you need to assert that element is visible, prefer [method: LocatorAssertions.toBeVisible] to avoid flakiness. See assertions guide for more details.

Usage

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

Parameters:

  • timeout: (Float) (defaults to: nil)

Returns:

  • (Boolean) 


932
933
934
 
# File 'lib/playwright_api/locator.rb', line 932

def visible?(timeout: nil)
  wrap_impl(@impl.visible?(timeout: unwrap_impl(timeout)))
end

#wait_for(state: nil, timeout: nil) ⇒ void

This method returns an undefined value.

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

Parameters:

  • state: ("attached", "detached", "visible", "hidden") (defaults to: nil)
  • timeout: (Float) (defaults to: nil) 


1332
1333
1334
 
# File 'lib/playwright_api/locator.rb', line 1332

def wait_for(state: nil, timeout: nil)
  wrap_impl(@impl.wait_for(state: unwrap_impl(state), timeout: unwrap_impl(timeout)))
end

#wait_for_function(expression, arg: nil, timeout: nil) ⇒ void

This method returns an undefined value.

Returns when expression returns a truthy value, called with the matching element as a first argument, and arg as a second argument.

This is a generic way to wait for an element to reach a custom condition without asserting it. The locator is re-resolved on each retry, so it tolerates the element being re-rendered while waiting.

If expression returns a [Promise], this method will wait for the promise to resolve before checking its value.

If expression throws or rejects, this method throws.

Usage

Wait for an attribute to appear:

Passing argument to expression:

Parameters:

  • expression (String)
  • arg: (Object) (defaults to: nil)
  • timeout: (Float) (defaults to: nil) 


1350
1351
1352
 
# File 'lib/playwright_api/locator.rb', line 1350

def wait_for_function(expression, arg: nil, timeout: nil)
  wrap_impl(@impl.wait_for_function(unwrap_impl(expression), arg: unwrap_impl(arg), timeout: unwrap_impl(timeout)))
end