Class: Playwright::Frame

Inherits:
PlaywrightApi show all
Defined in:
lib/playwright_api/frame.rb

Overview

At every point of time, page exposes its current frame tree via the [‘method: Page.mainFrame`] and

‘method: Frame.childFrames`

methods.

‘Frame` object’s lifecycle is controlled by three events, dispatched on the page object:

  • ‘event: Page.frameattached`

    • fired when the frame gets attached to the page. A Frame can be attached to the page

    only once.

  • ‘event: Page.framenavigated`

    • fired when the frame commits navigation to a different URL.

  • ‘event: Page.framedetached`

    • fired when the frame gets detached from the page. A Frame can be detached from the

    page only once.

An example of dumping frame tree:

“‘js const { firefox } = require(’playwright’); // Or ‘chromium’ or ‘webkit’.

(async () => {

const browser = await firefox.launch();
const page = await browser.newPage();
await page.goto('https://www.google.com/chrome/browser/canary.html');
dumpFrameTree(page.mainFrame(), '');
await browser.close();

function dumpFrameTree(frame, indent) {
  console.log(indent + frame.url());
  for (const child of frame.childFrames()) {
    dumpFrameTree(child, indent + '  ');
  }
}

})(); “‘

An example of getting text from an iframe element:

“‘js const frame = page.frames().find(frame => frame.name() === ’myframe’); const text = await frame.$eval(‘.selector’, element => element.textContent); console.log(text); “‘

Instance Method Summary collapse

Methods inherited from PlaywrightApi

from_channel_owner

Instance Method Details

#add_script_tag(content: nil, path: nil, type: nil, url: nil) ⇒ Object

Returns the added tag when the script’s onload fires or when the script content was injected into frame.

Adds a ‘<script>` tag into the page with the desired url or content.

Raises:

  • (NotImplementedError) 


103
104
105
 
# File 'lib/playwright_api/frame.rb', line 103

def add_script_tag(content: nil, path: nil, type: nil, url: nil)
  raise NotImplementedError.new('add_script_tag is not implemented yet.')
end

#add_style_tag(content: nil, path: nil, url: nil) ⇒ Object

Returns the added tag when the stylesheet’s onload fires or when the CSS content was injected into frame.

Adds a ‘<link rel=“stylesheet”>` tag into the page with the desired url or a `<style type=“text/css”>` tag with the content.

Raises:

  • (NotImplementedError) 


111
112
113
 
# File 'lib/playwright_api/frame.rb', line 111

def add_style_tag(content: nil, path: nil, url: nil)
  raise NotImplementedError.new('add_style_tag is not implemented yet.')
end

#after_initialize ⇒ Object 



670
671
672
 
# File 'lib/playwright_api/frame.rb', line 670

def after_initialize
  wrap_channel_owner(@channel_owner.after_initialize)
end

#check(selector, force: nil, noWaitAfter: nil, timeout: nil) ⇒ Object

This method checks an element matching ‘selector` by performing the following steps:

  1. Find an element match matching ‘selector`. If there is none, wait until a matching element is attached to the DOM.

  2. Ensure that matched element is a checkbox or a radio input. If not, this method rejects. If the element is already checked, this method returns immediately.

  3. Wait for [actionability](./actionability.md) 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. Wait for initiated navigations to either succeed or fail, unless ‘noWaitAfter` option is set.

  7. Ensure that the element is now checked. If not, this method rejects.

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

Raises:

  • (NotImplementedError) 


128
129
130
 
# File 'lib/playwright_api/frame.rb', line 128

def check(selector, force: nil, noWaitAfter: nil, timeout: nil)
  raise NotImplementedError.new('check is not implemented yet.')
end

#checked?(selector, timeout: nil) ⇒ Boolean

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

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


382
383
384
 
# File 'lib/playwright_api/frame.rb', line 382

def checked?(selector, timeout: nil)
  raise NotImplementedError.new('checked? is not implemented yet.')
end

#child_frames ⇒ Object

Raises:

  • (NotImplementedError) 


132
133
134
 
# File 'lib/playwright_api/frame.rb', line 132

def child_frames
  raise NotImplementedError.new('child_frames is not implemented yet.')
end

#click(selector, button: nil, clickCount: nil, delay: nil, force: nil, modifiers: nil, noWaitAfter: nil, position: nil, timeout: nil) ⇒ Object

This method clicks an element matching ‘selector` by performing the following steps:

  1. Find an element match matching ‘selector`. If there is none, wait until a matching element is attached to the DOM.

  2. Wait for [actionability](./actionability.md) checks on the matched element, unless ‘force` option is set. If the element is detached during the checks, the whole action is retried.

  3. Scroll the element into view if needed.

  4. Use [‘property: Page.mouse`] to click in the center of the element, or the specified `position`.

  5. Wait for initiated navigations to either succeed or fail, unless ‘noWaitAfter` option is set.

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

Raises:

  • (NotImplementedError) 


146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/playwright_api/frame.rb', line 146

def click(
      selector,
      button: nil,
      clickCount: nil,
      delay: nil,
      force: nil,
      modifiers: nil,
      noWaitAfter: nil,
      position: nil,
      timeout: nil)
  raise NotImplementedError.new('click is not implemented yet.')
end

#content ⇒ Object

Gets the full HTML contents of the frame, including the doctype.

Raises:

  • (NotImplementedError) 


160
161
162
 
# File 'lib/playwright_api/frame.rb', line 160

def content
  raise NotImplementedError.new('content is not implemented yet.')
end

#dblclick(selector, button: nil, delay: nil, force: nil, modifiers: nil, noWaitAfter: nil, position: nil, timeout: nil) ⇒ Object

This method double clicks an element matching ‘selector` by performing the following steps:

  1. Find an element match matching ‘selector`. If there is none, wait until a matching element is attached to the DOM.

  2. Wait for [actionability](./actionability.md) checks on the matched element, unless ‘force` option is set. If the element is detached during the checks, the whole action is retried.

  3. Scroll the element into view if needed.

  4. Use [‘property: Page.mouse`] to double click in the center of the element, or the specified `position`.

  5. Wait for initiated navigations to either succeed or fail, unless ‘noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will reject.

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

> NOTE ‘frame.dblclick()` dispatches two `click` events and a single `dblclick` event.

Raises:

  • (NotImplementedError) 


177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/playwright_api/frame.rb', line 177

def dblclick(
      selector,
      button: nil,
      delay: nil,
      force: nil,
      modifiers: nil,
      noWaitAfter: nil,
      position: nil,
      timeout: nil)
  raise NotImplementedError.new('dblclick is not implemented yet.')
end

#detached? ⇒ Boolean

Returns ‘true` if the frame has been detached, or `false` otherwise.

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


387
388
389
 
# File 'lib/playwright_api/frame.rb', line 387

def detached?
  raise NotImplementedError.new('detached? is not implemented yet.')
end

#disabled?(selector, timeout: nil) ⇒ Boolean

Returns whether the element is disabled, the opposite of [enabled](./actionability.md#enabled).

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


392
393
394
 
# File 'lib/playwright_api/frame.rb', line 392

def disabled?(selector, timeout: nil)
  raise NotImplementedError.new('disabled? is not implemented yet.')
end

#dispatch_event(selector, type, eventInit: nil, timeout: nil) ⇒ Object

The snippet below dispatches the ‘click` event on the element. Regardless of the visibility state of the elment, `click` is dispatched. This is equivalend to calling [element.click()](developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click).

“‘js await frame.dispatchEvent(’button#submit’, ‘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:

“‘js // Note you can only create DataTransfer in Chromium and Firefox const dataTransfer = await frame.evaluateHandle(() => new DataTransfer()); await frame.dispatchEvent(’#source’, ‘dragstart’, { dataTransfer }); “‘

Raises:

  • (NotImplementedError) 


218
219
220
 
# File 'lib/playwright_api/frame.rb', line 218

def dispatch_event(selector, type, eventInit: nil, timeout: nil)
  raise NotImplementedError.new('dispatch_event is not implemented yet.')
end

#editable?(selector, timeout: nil) ⇒ Boolean

Returns whether the element is [editable](./actionability.md#editable).

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


397
398
399
 
# File 'lib/playwright_api/frame.rb', line 397

def editable?(selector, timeout: nil)
  raise NotImplementedError.new('editable? is not implemented yet.')
end

#enabled?(selector, timeout: nil) ⇒ Boolean

Returns whether the element is [enabled](./actionability.md#enabled).

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


402
403
404
 
# File 'lib/playwright_api/frame.rb', line 402

def enabled?(selector, timeout: nil)
  raise NotImplementedError.new('enabled? is not implemented yet.')
end

#eval_on_selector(selector, pageFunction, arg: nil) ⇒ Object

Returns the return value of ‘pageFunction`

The method finds an element matching the specified selector within the frame and passes it as a first argument to ‘pageFunction`. See [Working with selectors](./selectors.md#working-with-selectors) for more details. If no elements match the selector, the method throws an error.

If ‘pageFunction` returns a [Promise], then `frame.$eval` would wait for the promise to resolve and return its value.

Examples:

“‘js const searchValue = await frame.$eval(’#search’, el => el.value); const preloadHref = await frame.$eval(‘link’, el => el.href); const html = await frame.$eval(‘.main-container’, (e, suffix) => e.outerHTML + suffix, ‘hello’); “‘

Raises:

  • (NotImplementedError) 


78
79
80
 
# File 'lib/playwright_api/frame.rb', line 78

def eval_on_selector(selector, pageFunction, arg: nil)
  raise NotImplementedError.new('eval_on_selector is not implemented yet.')
end

#eval_on_selector_all(selector, pageFunction, arg: nil) ⇒ Object

Returns the return value of ‘pageFunction`

The method finds all elements matching the specified selector within the frame and passes an array of matched elements as a first argument to ‘pageFunction`. See [Working with selectors](./selectors.md#working-with-selectors) for more details.

If ‘pageFunction` returns a [Promise], then `frame.$$eval` would wait for the promise to resolve and return its value.

Examples:

“‘js const divsCounts = await frame.$$eval(’div’, (divs, min) => divs.length >= min, 10); “‘

Raises:

  • (NotImplementedError) 


96
97
98
 
# File 'lib/playwright_api/frame.rb', line 96

def eval_on_selector_all(selector, pageFunction, arg: nil)
  raise NotImplementedError.new('eval_on_selector_all is not implemented yet.')
end

#evaluate(pageFunction, arg: nil) ⇒ Object

Returns the return value of ‘pageFunction`

If the function passed to the ‘frame.evaluate` returns a [Promise], then `frame.evaluate` would wait for the promise to resolve and return its value.

If the function passed to the ‘frame.evaluate` returns a non- value, then `frame.evaluate` returns `undefined`. DevTools Protocol also supports transferring some additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals.

“‘js const result = await frame.evaluate(([x, y]) => 

return Promise.resolve(x * y);

, [7, 8]); console.log(result); // prints “56” “‘

A string can also be passed in instead of a function.

“‘js console.log(await frame.evaluate(’1 + 2’)); // prints “3” “‘

‘ElementHandle` instances can be passed as an argument to the `frame.evaluate`:

“‘js const bodyHandle = await frame.$(’body’); const html = await frame.evaluate(([body, suffix]) => body.innerHTML + suffix, [bodyHandle, ‘hello’]); await bodyHandle.dispose(); “‘

Raises:

  • (NotImplementedError) 


254
255
256
 
# File 'lib/playwright_api/frame.rb', line 254

def evaluate(pageFunction, arg: nil)
  raise NotImplementedError.new('evaluate is not implemented yet.')
end

#evaluate_handle(pageFunction, arg: nil) ⇒ Object

Returns the return value of ‘pageFunction` as in-page object (JSHandle).

The only difference between ‘frame.evaluate` and `frame.evaluateHandle` is that `frame.evaluateHandle` returns in-page object (JSHandle).

If the function, passed to the ‘frame.evaluateHandle`, returns a [Promise], then `frame.evaluateHandle` would wait for the promise to resolve and return its value.

“‘js const aWindowHandle = await frame.evaluateHandle(() => Promise.resolve(window)); aWindowHandle; // Handle for the window object. “`

A string can also be passed in instead of a function.

“‘js const aHandle = await frame.evaluateHandle(’document’); // Handle for the ‘document’. “‘

‘JSHandle` instances can be passed as an argument to the `frame.evaluateHandle`:

“‘js const aHandle = await frame.evaluateHandle(() => document.body); const resultHandle = await frame.evaluateHandle(([body, suffix]) => body.innerHTML + suffix, [aHandle, ’hello’]); console.log(await resultHandle.jsonValue()); await resultHandle.dispose(); “‘

Raises:

  • (NotImplementedError) 


288
289
290
 
# File 'lib/playwright_api/frame.rb', line 288

def evaluate_handle(pageFunction, arg: nil)
  raise NotImplementedError.new('evaluate_handle is not implemented yet.')
end

#fill(selector, value, noWaitAfter: nil, timeout: nil) ⇒ Object

This method waits for an element matching ‘selector`, waits for [actionability](./actionability.md) checks, focuses the element, fills it and triggers an `input` event after filling. If the element matching `selector` is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method throws an error. Note that you can pass an empty string to clear the input field.

To send fine-grained keyboard events, use [‘method: Frame.type`].

Raises:

  • (NotImplementedError) 


298
299
300
 
# File 'lib/playwright_api/frame.rb', line 298

def fill(selector, value, noWaitAfter: nil, timeout: nil)
  raise NotImplementedError.new('fill is not implemented yet.')
end

#focus(selector, timeout: nil) ⇒ Object

This method fetches an element with ‘selector` and focuses it. If there’s no element matching ‘selector`, the method waits until a matching element appears in the DOM.

Raises:

  • (NotImplementedError) 


304
305
306
 
# File 'lib/playwright_api/frame.rb', line 304

def focus(selector, timeout: nil)
  raise NotImplementedError.new('focus is not implemented yet.')
end

#frame_element ⇒ Object

Returns the ‘frame` or `iframe` element handle which corresponds to this frame.

This is an inverse of [‘method: ElementHandle.contentFrame`]. Note that returned handle actually belongs to the parent frame.

This method throws an error if the frame has been detached before ‘frameElement()` returns.

“‘js const frameElement = await frame.frameElement(); const contentFrame = await frameElement.contentFrame(); console.log(frame === contentFrame); // -> true “`

Raises:

  • (NotImplementedError) 


321
322
323
 
# File 'lib/playwright_api/frame.rb', line 321

def frame_element
  raise NotImplementedError.new('frame_element is not implemented yet.')
end

#get_attribute(selector, name, timeout: nil) ⇒ Object

Returns element attribute value.

Raises:

  • (NotImplementedError) 


326
327
328
 
# File 'lib/playwright_api/frame.rb', line 326

def get_attribute(selector, name, timeout: nil)
  raise NotImplementedError.new('get_attribute is not implemented yet.')
end

#goto(url, referer: nil, timeout: nil, waitUntil: nil) ⇒ Object

Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.

‘frame.goto` will throw an error if:

  • there’s an SSL error (e.g. in case of self-signed certificates).

  • target URL is invalid.

  • the ‘timeout` is exceeded during navigation.

  • the remote server does not respond or is unreachable.

  • the main resource failed to load.

‘frame.goto` will not throw an error when any valid HTTP status code is returned by the remote server, including 404 “Not Found” and 500 “Internal Server Error”. The status code for such responses can be retrieved by calling [`method: Response.status`].

> NOTE ‘frame.goto` either throws an error or returns a main resource response. The only exceptions are navigation to `about:blank` or navigation to the same URL with a different hash, which would succeed and return `null`. > NOTE Headless mode doesn’t support navigation to a PDF document. See the [upstream issue](bugs.chromium.org/p/chromium/issues/detail?id=761295).



348
349
350
 
# File 'lib/playwright_api/frame.rb', line 348

def goto(url, referer: nil, timeout: nil, waitUntil: nil)
  wrap_channel_owner(@channel_owner.goto(url, referer: referer, timeout: timeout, waitUntil: waitUntil))
end

#hidden?(selector, timeout: nil) ⇒ Boolean

Returns whether the element is hidden, the opposite of [visible](./actionability.md#visible).

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


407
408
409
 
# File 'lib/playwright_api/frame.rb', line 407

def hidden?(selector, timeout: nil)
  raise NotImplementedError.new('hidden? is not implemented yet.')
end

#hover(selector, force: nil, modifiers: nil, position: nil, timeout: nil) ⇒ Object

This method hovers over an element matching ‘selector` by performing the following steps:

  1. Find an element match matching ‘selector`. If there is none, wait until a matching element is attached to the DOM.

  2. Wait for [actionability](./actionability.md) checks on the matched element, unless ‘force` option is set. If the element is detached during the checks, the whole action is retried.

  3. Scroll the element into view if needed.

  4. Use [‘property: Page.mouse`] to hover over the center of the element, or the specified `position`.

  5. Wait for initiated navigations to either succeed or fail, unless ‘noWaitAfter` option is set.

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

Raises:

  • (NotImplementedError) 


362
363
364
365
366
367
368
369
 
# File 'lib/playwright_api/frame.rb', line 362

def hover(
      selector,
      force: nil,
      modifiers: nil,
      position: nil,
      timeout: nil)
  raise NotImplementedError.new('hover is not implemented yet.')
end

#inner_html(selector, timeout: nil) ⇒ Object

Returns ‘element.innerHTML`.

Raises:

  • (NotImplementedError) 


372
373
374
 
# File 'lib/playwright_api/frame.rb', line 372

def inner_html(selector, timeout: nil)
  raise NotImplementedError.new('inner_html is not implemented yet.')
end

#inner_text(selector, timeout: nil) ⇒ Object

Returns ‘element.innerText`.

Raises:

  • (NotImplementedError) 


377
378
379
 
# File 'lib/playwright_api/frame.rb', line 377

def inner_text(selector, timeout: nil)
  raise NotImplementedError.new('inner_text is not implemented yet.')
end

#name ⇒ Object

Returns frame’s name attribute as specified in the tag.

If the name is empty, returns the id attribute instead.

> NOTE This value is calculated once when the frame is created, and will not update if the attribute is changed later.

Raises:

  • (NotImplementedError) 


422
423
424
 
# File 'lib/playwright_api/frame.rb', line 422

def name
  raise NotImplementedError.new('name is not implemented yet.')
end

#page ⇒ Object

Returns the page containing this frame.



427
428
429
 
# File 'lib/playwright_api/frame.rb', line 427

def page
  wrap_channel_owner(@channel_owner.page)
end

#parent_frame ⇒ Object

Parent frame, if any. Detached frames and main frames return ‘null`.

Raises:

  • (NotImplementedError) 


432
433
434
 
# File 'lib/playwright_api/frame.rb', line 432

def parent_frame
  raise NotImplementedError.new('parent_frame is not implemented yet.')
end

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

‘key` can specify the intended [keyboardEvent.key](developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) value or a single character to generate the text for. A superset of the `key` values can be found [here](developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). Examples of the keys are:

‘F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`, `Delete`, `Escape`, `ArrowDown`, `End`, `Enter`, `Home`, `Insert`, `PageDown`, `PageUp`, `ArrowRight`, `ArrowUp`, etc.

Following modification shortcuts are also supported: ‘Shift`, `Control`, `Alt`, `Meta`, `ShiftLeft`.

Holding down ‘Shift` will type the text that corresponds to the `key` in the upper case.

If ‘key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different respective texts.

Shortcuts such as ‘key: “Control+o”` or `key: “Control+Shift+T”` are supported as well. When speficied with the modifier, modifier is pressed and being held while the subsequent key is being pressed.

Raises:

  • (NotImplementedError) 


452
453
454
455
456
457
458
459
 
# File 'lib/playwright_api/frame.rb', line 452

def press(
      selector,
      key,
      delay: nil,
      noWaitAfter: nil,
      timeout: nil)
  raise NotImplementedError.new('press is not implemented yet.')
end

#query_selector(selector) ⇒ Object

Returns the ElementHandle pointing to the frame element.

The method finds an element matching the specified selector within the frame. See [Working with selectors](./selectors.md#working-with-selectors) for more details. If no elements match the selector, returns ‘null`.

Raises:

  • (NotImplementedError) 


49
50
51
 
# File 'lib/playwright_api/frame.rb', line 49

def query_selector(selector)
  raise NotImplementedError.new('query_selector is not implemented yet.')
end

#query_selector_all(selector) ⇒ Object

Returns the ElementHandles pointing to the frame elements.

The method finds all elements matching the specified selector within the frame. See [Working with selectors](./selectors.md#working-with-selectors) for more details. If no elements match the selector, returns empty array.

Raises:

  • (NotImplementedError) 


58
59
60
 
# File 'lib/playwright_api/frame.rb', line 58

def query_selector_all(selector)
  raise NotImplementedError.new('query_selector_all is not implemented yet.')
end

#select_option(selector, values, noWaitAfter: nil, timeout: nil) ⇒ Object

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. If there’s no ‘<select>` element matching `selector`, the method throws an error.

“‘js // single selection matching the value frame.selectOption(’select#colors’, ‘blue’);

// single selection matching both the value and the label frame.selectOption(‘select#colors’, { label: ‘Blue’ });

// multiple selection frame.selectOption(‘select#colors’, ‘red’, ‘green’, ‘blue’); “‘

Raises:

  • (NotImplementedError) 


477
478
479
 
# File 'lib/playwright_api/frame.rb', line 477

def select_option(selector, values, noWaitAfter: nil, timeout: nil)
  raise NotImplementedError.new('select_option is not implemented yet.')
end

#set_content(html, timeout: nil, waitUntil: nil) ⇒ Object

Raises:

  • (NotImplementedError) 


481
482
483
 
# File 'lib/playwright_api/frame.rb', line 481

def set_content(html, timeout: nil, waitUntil: nil)
  raise NotImplementedError.new('set_content is not implemented yet.')
end

#set_input_files(selector, files, noWaitAfter: nil, timeout: nil) ⇒ Object

This method expects ‘selector` to point to an [input element](developer.mozilla.org/en-US/docs/Web/HTML/Element/input).

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 the current working directory. For empty array, clears the selected files.

Raises:

  • (NotImplementedError) 


490
491
492
 
# File 'lib/playwright_api/frame.rb', line 490

def set_input_files(selector, files, noWaitAfter: nil, timeout: nil)
  raise NotImplementedError.new('set_input_files is not implemented yet.')
end

#tap_point(selector, force: nil, modifiers: nil, noWaitAfter: nil, position: nil, timeout: nil) ⇒ Object

This method taps an element matching ‘selector` by performing the following steps:

  1. Find an element match matching ‘selector`. If there is none, wait until a matching element is attached to the DOM.

  2. Wait for [actionability](./actionability.md) checks on the matched element, unless ‘force` option is set. If the element is detached during the checks, the whole action is retried.

  3. Scroll the element into view if needed.

  4. Use [‘property: Page.touchscreen`] to tap the center of the element, or the specified `position`.

  5. Wait for initiated navigations to either succeed or fail, unless ‘noWaitAfter` option is set.

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

> NOTE ‘frame.tap()` requires that the `hasTouch` option of the browser context be set to true.

Raises:

  • (NotImplementedError) 


506
507
508
509
510
511
512
513
514
 
# File 'lib/playwright_api/frame.rb', line 506

def tap_point(
      selector,
      force: nil,
      modifiers: nil,
      noWaitAfter: nil,
      position: nil,
      timeout: nil)
  raise NotImplementedError.new('tap_point is not implemented yet.')
end

#text_content(selector, timeout: nil) ⇒ Object

Returns ‘element.textContent`.

Raises:

  • (NotImplementedError) 


517
518
519
 
# File 'lib/playwright_api/frame.rb', line 517

def text_content(selector, timeout: nil)
  raise NotImplementedError.new('text_content is not implemented yet.')
end

#title ⇒ Object

Returns the page title.

Raises:

  • (NotImplementedError) 


522
523
524
 
# File 'lib/playwright_api/frame.rb', line 522

def title
  raise NotImplementedError.new('title is not implemented yet.')
end

#type_text(selector, text, delay: nil, noWaitAfter: nil, timeout: nil) ⇒ Object

Sends a ‘keydown`, `keypress`/`input`, and `keyup` event for each character in the text. `frame.type` can be used to send fine-grained keyboard events. To fill values in form fields, use [`method: Frame.fill`].

To press a special key, like ‘Control` or `ArrowDown`, use [`method: Keyboard.press`].

“‘js await frame.type(’#mytextarea’, ‘Hello’); // Types instantly await frame.type(‘#mytextarea’, ‘World’, 100); // Types slower, like a user “‘

Raises:

  • (NotImplementedError) 


536
537
538
539
540
541
542
543
 
# File 'lib/playwright_api/frame.rb', line 536

def type_text(
      selector,
      text,
      delay: nil,
      noWaitAfter: nil,
      timeout: nil)
  raise NotImplementedError.new('type_text is not implemented yet.')
end

#uncheck(selector, force: nil, noWaitAfter: nil, timeout: nil) ⇒ Object

This method checks an element matching ‘selector` by performing the following steps:

  1. Find an element match matching ‘selector`. If there is none, wait until a matching element is attached to the DOM.

  2. Ensure that matched element is a checkbox or a radio input. If not, this method rejects. If the element is already unchecked, this method returns immediately.

  3. Wait for [actionability](./actionability.md) 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. Wait for initiated navigations to either succeed or fail, unless ‘noWaitAfter` option is set.

  7. Ensure that the element is now unchecked. If not, this method rejects.

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

Raises:

  • (NotImplementedError) 


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

def uncheck(selector, force: nil, noWaitAfter: nil, timeout: nil)
  raise NotImplementedError.new('uncheck is not implemented yet.')
end

#url ⇒ Object

Returns frame’s url.

Raises:

  • (NotImplementedError) 


563
564
565
 
# File 'lib/playwright_api/frame.rb', line 563

def url
  raise NotImplementedError.new('url is not implemented yet.')
end

#visible?(selector, timeout: nil) ⇒ Boolean

Returns whether the element is [visible](./actionability.md#visible).

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


412
413
414
 
# File 'lib/playwright_api/frame.rb', line 412

def visible?(selector, timeout: nil)
  raise NotImplementedError.new('visible? is not implemented yet.')
end

#wait_for_function(pageFunction, arg: nil, polling: nil, timeout: nil) ⇒ Object

Returns when the ‘pageFunction` returns a truthy value, returns that value.

The ‘waitForFunction` can be used to observe viewport size change:

“‘js const { firefox } = require(’playwright’); // Or ‘chromium’ or ‘webkit’.

(async () => 

const browser = await firefox.launch();
const page = await browser.newPage();
const watchDog = page.mainFrame().waitForFunction('window.innerWidth < 100');
page.setViewportSize({width: 50, height: 50);
await watchDog;
await browser.close();

})(); “‘

To pass an argument to the predicate of ‘frame.waitForFunction` function:

“‘js const selector = ’.foo’; await frame.waitForFunction(selector => !!document.querySelector(selector), selector); “‘

Raises:

  • (NotImplementedError) 


592
593
594
 
# File 'lib/playwright_api/frame.rb', line 592

def wait_for_function(pageFunction, arg: nil, polling: nil, timeout: nil)
  raise NotImplementedError.new('wait_for_function is not implemented yet.')
end

#wait_for_load_state(state: nil, timeout: nil) ⇒ Object

Waits for the required load state to be reached.

This returns when the frame reaches a required load state, ‘load` by default. The navigation must have been committed when this method is called. If current document has already reached the required state, resolves immediately.

“‘js await frame.click(’button’); // Click triggers navigation. await frame.waitForLoadState(); // Waits for ‘load’ state by default. “‘

Raises:

  • (NotImplementedError) 


606
607
608
 
# File 'lib/playwright_api/frame.rb', line 606

def wait_for_load_state(state: nil, timeout: nil)
  raise NotImplementedError.new('wait_for_load_state is not implemented yet.')
end

#wait_for_navigation(timeout: nil, url: nil, waitUntil: nil) ⇒ Object

Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. In case of navigation to a different anchor or navigation due to History API usage, the navigation will resolve with ‘null`.

This method waits for the frame to navigate to a new URL. It is useful for when you run code which will indirectly cause the frame to navigate. Consider this example:

“‘js const [response] = await Promise.all([

frame.waitForNavigation(), // Wait for the navigation to finish
frame.click('a.my-link'), // Clicking the link will indirectly cause a navigation

]); “‘

NOTE Usage of the [History API](developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is considered a navigation.

Raises:

  • (NotImplementedError) 


627
628
629
 
# File 'lib/playwright_api/frame.rb', line 627

def wait_for_navigation(timeout: nil, url: nil, waitUntil: nil)
  raise NotImplementedError.new('wait_for_navigation is not implemented yet.')
end

#wait_for_selector(selector, state: nil, timeout: nil) ⇒ Object

Returns when element specified by selector satisfies ‘state` option. Returns `null` if waiting for `hidden` or `detached`.

Wait for the ‘selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If at the moment of calling the method `selector` already satisfies the condition, the method will return immediately. If the selector doesn’t satisfy the condition for the ‘timeout` milliseconds, the function will throw.

This method works across navigations:

“‘js const { webkit } = require(’playwright’); // Or ‘chromium’ or ‘firefox’.

(async () => {

const browser = await webkit.launch();
const page = await browser.newPage();
let currentURL;
page.mainFrame()
  .waitForSelector('img')
  .then(() => console.log('First URL with image: ' + currentURL));
for (currentURL of ['https://example.com', 'https://google.com', 'https://bbc.com']) {
  await page.goto(currentURL);
}
await browser.close();

})(); “‘

Raises:

  • (NotImplementedError) 


657
658
659
 
# File 'lib/playwright_api/frame.rb', line 657

def wait_for_selector(selector, state: nil, timeout: nil)
  raise NotImplementedError.new('wait_for_selector is not implemented yet.')
end

#wait_for_timeout(timeout) ⇒ Object

Waits for the given ‘timeout` in milliseconds.

Note that ‘frame.waitForTimeout()` should only be used for debugging. Tests using the timer in production are going to be flaky. Use signals such as network events, selectors becoming visible and others instead.

Raises:

  • (NotImplementedError) 


665
666
667
 
# File 'lib/playwright_api/frame.rb', line 665

def wait_for_timeout(timeout)
  raise NotImplementedError.new('wait_for_timeout is not implemented yet.')
end