Class: Puppeteer::ElementHandle

Inherits:
JSHandle
  • Object
show all
Includes:
DebugPrint, IfPresent
Defined in:
lib/puppeteer/element_handle.rb,
lib/puppeteer/element_handle/point.rb,
lib/puppeteer/element_handle/offset.rb,
lib/puppeteer/element_handle/box_model.rb,
lib/puppeteer/element_handle/bounding_box.rb

Defined Under Namespace

Classes: BoundingBox, BoxModel, DragInterceptionNotEnabledError, ElementNotClickableError, ElementNotFoundError, ElementNotVisibleError, Offset, Point, ScrollIntoViewError

Instance Attribute Summary collapse

Attributes inherited from JSHandle

#context, #remote_object

Instance Method Summary collapse

Methods included from IfPresent

#if_present

Methods included from DebugPrint

#debug_print, #debug_puts

Methods inherited from JSHandle

#[], create, #dispose, #disposed?, #evaluate, #evaluate_handle, #execution_context, #json_value, #properties, #property, #to_s

Constructor Details

#initialize(context:, client:, remote_object:, frame:) ⇒ ElementHandle

Returns a new instance of ElementHandle.

Parameters:



15
16
17
18
19
20
21
 
# File 'lib/puppeteer/element_handle.rb', line 15

def initialize(context:, client:, remote_object:, frame:)
  super(context: context, client: client, remote_object: remote_object)
  @frame = frame
  @page = frame.page
  @frame_manager = frame.frame_manager
  @disposed = false
end

Instance Attribute Details

#frame ⇒ Object (readonly)

Returns the value of attribute frame.



23
24
25
 
# File 'lib/puppeteer/element_handle.rb', line 23

def frame
  @frame
end

#frame_manager ⇒ Object (readonly)

Returns the value of attribute frame_manager.



23
24
25
 
# File 'lib/puppeteer/element_handle.rb', line 23

def frame_manager
  @frame_manager
end

#page ⇒ Object (readonly)

Returns the value of attribute page.



23
24
25
 
# File 'lib/puppeteer/element_handle.rb', line 23

def page
  @page
end

Instance Method Details

#as_element ⇒ Object 



136
137
138
 
# File 'lib/puppeteer/element_handle.rb', line 136

def as_element
  self
end

#bounding_box ⇒ BoundingBox|nil

Returns:



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/puppeteer/element_handle.rb', line 478

def bounding_box
  if_present(box_model) do |result_model|
    offset = oopif_offsets(@frame)
    quads = result_model.border

    x = quads.map(&:x).min
    y = quads.map(&:y).min
    BoundingBox.new(
      x: x + offset.x,
      y: y + offset.y,
      width: quads.map(&:x).max - x,
      height: quads.map(&:y).max - y,
    )
  end
end

#box_model ⇒ BoxModel|nil

Returns:



495
496
497
498
499
 
# File 'lib/puppeteer/element_handle.rb', line 495

def box_model
  if_present(@remote_object.box_model(@client)) do |result|
    BoxModel.new(result['model'], offset: oopif_offsets(@frame))
  end
end

#click(delay: nil, button: nil, click_count: nil, offset: nil) ⇒ Object

Parameters:

  • delay (Number) (defaults to: nil)
  • button (String) (defaults to: nil) —

    “left”|“right”|“middle”

  • click_count (Number) (defaults to: nil)
  • offset (Hash) (defaults to: nil) 


324
325
326
327
328
 
# File 'lib/puppeteer/element_handle.rb', line 324

def click(delay: nil, button: nil, click_count: nil, offset: nil)
  scroll_into_view_if_needed
  point = clickable_point(offset)
  @page.mouse.click(point.x, point.y, delay: delay, button: button, click_count: click_count)
end

#clickable_point(offset = nil) ⇒ Object 



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/puppeteer/element_handle.rb', line 238

def clickable_point(offset = nil)
  offset_param = Offset.from(offset)

  result =
    begin
      @remote_object.content_quads(@client)
    rescue => err
      debug_puts(err)
      nil
    end

  if !result || result["quads"].empty?
    raise ElementNotVisibleError.new
  end

  # Filter out quads that have too small area to click into.
  layout_metrics = @page.client.send_message('Page.getLayoutMetrics')

  if result.empty? || result["quads"].empty?
    raise ElementNotClickableError.new
  end

  # Filter out quads that have too small area to click into.
  # Fallback to `layoutViewport` in case of using Firefox.
  layout_viewport = layout_metrics["cssLayoutViewport"] || layout_metrics["layoutViewport"]
  client_width = layout_viewport["clientWidth"]
  client_height = layout_viewport["clientHeight"]

  oopif_offset = oopif_offsets(@frame)
  quads = result["quads"].
            map { |quad| from_protocol_quad(quad) }.
            map { |quad| apply_offsets_to_quad(quad, oopif_offset) }.
            map { |quad| intersect_quad_with_viewport(quad, client_width, client_height) }.
            select { |quad| compute_quad_area(quad) > 1 }
  if quads.empty?
    raise ElementNotVisibleError.new
  end

  if offset_param
    # Return the point of the first quad identified by offset.
    quad = quads.first
    min_x = quad.map(&:x).min
    min_y = quad.map(&:y).min
    if min_x && min_y
      return Point.new(
        x: min_x + offset_param.x,
        y: min_y + offset_param.y,
      )
    end
  end

  # Return the middle point of the first quad.
  quads.first.reduce(:+) / 4
end

#content_frame ⇒ Object 



140
141
142
143
144
145
146
147
148
 
# File 'lib/puppeteer/element_handle.rb', line 140

def content_frame
  node_info = @remote_object.node_info(@client)
  frame_id = node_info['node']['frameId']
  if frame_id.is_a?(String)
    @frame_manager.frame(frame_id)
  else
    nil
  end
end

#drag(x:, y:) ⇒ Object 



338
339
340
341
342
343
344
345
 
# File 'lib/puppeteer/element_handle.rb', line 338

def drag(x:, y:)
  unless @page.drag_interception_enabled?
    raise DragInterceptionNotEnabledError.new
  end
  scroll_into_view_if_needed
  start = clickable_point
  @page.mouse.drag(start, Point.new(x: x, y: y))
end

#drag_and_drop(target, delay: nil) ⇒ Object

Parameters:



366
367
368
369
370
371
 
# File 'lib/puppeteer/element_handle.rb', line 366

def drag_and_drop(target, delay: nil)
  scroll_into_view_if_needed
  start_point = clickable_point
  target_point = target.clickable_point
  @page.mouse.drag_and_drop(start_point, target_point, delay: delay)
end

#drag_enter(data) ⇒ Object 



347
348
349
350
351
 
# File 'lib/puppeteer/element_handle.rb', line 347

def drag_enter(data)
  scroll_into_view_if_needed
  target = clickable_point
  @page.mouse.drag_enter(target, data)
end

#drag_over(data) ⇒ Object 



353
354
355
356
357
 
# File 'lib/puppeteer/element_handle.rb', line 353

def drag_over(data)
  scroll_into_view_if_needed
  target = clickable_point
  @page.mouse.drag_over(target, data)
end

#drop(data) ⇒ Object 



359
360
361
362
363
 
# File 'lib/puppeteer/element_handle.rb', line 359

def drop(data)
  scroll_into_view_if_needed
  target = clickable_point
  @page.mouse.drop(target, data)
end

#eval_on_selector(selector, page_function, *args) ⇒ Object Also known as: Seval

‘$eval()` in JavaScript.

Parameters:

  • selector (String)
  • page_function (String)

Returns:

  • (Object) 


598
599
600
601
602
603
604
605
606
607
 
# File 'lib/puppeteer/element_handle.rb', line 598

def eval_on_selector(selector, page_function, *args)
  element_handle = query_selector(selector)
  unless element_handle
    raise ElementNotFoundError.new(selector)
  end
  result = element_handle.evaluate(page_function, *args)
  element_handle.dispose

  result
end

#eval_on_selector_all(selector, page_function, *args) ⇒ Object Also known as: SSeval

‘$$eval()` in JavaScript.

Parameters:

  • selector (String)
  • page_function (String)

Returns:

  • (Object) 


616
617
618
619
620
621
622
 
# File 'lib/puppeteer/element_handle.rb', line 616

def eval_on_selector_all(selector, page_function, *args)
  handles = query_handler_manager.detect_query_handler(selector).query_all_array(self)
  result = handles.evaluate(page_function, *args)
  handles.dispose

  result
end

#focus ⇒ Object 



452
453
454
 
# File 'lib/puppeteer/element_handle.rb', line 452

def focus
  evaluate('element => element.focus()')
end

#hover ⇒ Object 



314
315
316
317
318
 
# File 'lib/puppeteer/element_handle.rb', line 314

def hover
  scroll_into_view_if_needed
  point = clickable_point
  @page.mouse.move(point.x, point.y)
end

#inspect ⇒ Object 



25
26
27
28
29
30
31
 
# File 'lib/puppeteer/element_handle.rb', line 25

def inspect
  values = %i[context remote_object page disposed].map do |sym|
    value = instance_variable_get(:"@#{sym}")
    "@#{sym}=#{value}"
  end
  "#<Puppeteer::ElementHandle #{values.join(' ')}>"
end

#intersecting_viewport?(threshold: nil) ⇒ Boolean

in JS, #isIntersectingViewport.

Parameters:

  • threshold (Float|nil) (defaults to: nil)

Returns:

  • (Boolean) 


646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/puppeteer/element_handle.rb', line 646

def intersecting_viewport?(threshold: nil)
  option_threshold = threshold || 0
  js = <<~JAVASCRIPT
  async (element, threshold) => {
    const visibleRatio = await new Promise(resolve => {
      const observer = new IntersectionObserver(entries => {
        resolve(entries[0].intersectionRatio);
        observer.disconnect();
      });
      observer.observe(element);
    });
    if (threshold === 1) return visibleRatio === 1;
    else return visibleRatio > threshold;
  }
  JAVASCRIPT

  evaluate(js, option_threshold)
end

#press(key, delay: nil, text: nil) ⇒ Object

Parameters:

  • key (String)
  • text (String) (defaults to: nil)
  • delay (number|nil) (defaults to: nil) 


470
471
472
473
 
# File 'lib/puppeteer/element_handle.rb', line 470

def press(key, delay: nil, text: nil)
  focus
  @page.keyboard.press(key, delay: delay, text: text)
end

#query_ax_tree(accessible_name: nil, role: nil) ⇒ Object

used in AriaQueryHandler



673
674
675
676
 
# File 'lib/puppeteer/element_handle.rb', line 673

def query_ax_tree(accessible_name: nil, role: nil)
  @remote_object.query_ax_tree(@client,
    accessible_name: accessible_name, role: role)
end

#query_selector(selector) ⇒ Object Also known as: S

‘$()` in JavaScript.

Parameters:

  • selector (String) 


576
577
578
 
# File 'lib/puppeteer/element_handle.rb', line 576

def query_selector(selector)
  query_handler_manager.detect_query_handler(selector).query_one(self)
end

#query_selector_all(selector) ⇒ Object Also known as: SS

‘$$()` in JavaScript.

Parameters:

  • selector (String) 


583
584
585
 
# File 'lib/puppeteer/element_handle.rb', line 583

def query_selector_all(selector)
  query_handler_manager.detect_query_handler(selector).query_all(self)
end

#screenshot(type: nil, path: nil, full_page: nil, clip: nil, quality: nil, omit_background: nil, encoding: nil, capture_beyond_viewport: nil, from_surface: nil) ⇒ Object 



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/puppeteer/element_handle.rb', line 501

def screenshot(type: nil,
               path: nil,
               full_page: nil,
               clip: nil,
               quality: nil,
               omit_background: nil,
               encoding: nil,
               capture_beyond_viewport: nil,
               from_surface: nil)
  needs_viewport_reset = false

  box = bounding_box
  unless box
    raise ElementNotVisibleError.new
  end

  viewport = @page.viewport
  if viewport && (box.width > viewport.width || box.height > viewport.height)
    new_viewport = viewport.merge(
      width: [viewport.width, box.width.to_i].min,
      height: [viewport.height, box.height.to_i].min,
    )
    @page.viewport = new_viewport

    needs_viewport_reset = true
  end
  scroll_into_view_if_needed

  box = bounding_box
  unless box
    raise ElementNotVisibleError.new
  end
  if box.width == 0
    raise 'Node has 0 width.'
  end
  if box.height == 0
    raise 'Node has 0 height.'
  end

  layout_metrics = @client.send_message('Page.getLayoutMetrics')
  page_x = layout_metrics["layoutViewport"]["pageX"]
  page_y = layout_metrics["layoutViewport"]["pageY"]

  if clip.nil?
    clip = {
      x: page_x + box.x,
      y: page_y + box.y,
      width: box.width,
      height: box.height,
    }
  end

  @page.screenshot(
    type: type,
    path: path,
    full_page:
    full_page,
    clip: clip,
    quality: quality,
    omit_background: omit_background,
    encoding: encoding,
    capture_beyond_viewport: capture_beyond_viewport,
    from_surface: from_surface)
ensure
  if needs_viewport_reset && viewport
    @page.viewport = viewport
  end
end

#scroll_into_view_if_needed ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/puppeteer/element_handle.rb', line 152

def scroll_into_view_if_needed
  js = <<~JAVASCRIPT
    async(element) => {
      if (!element.isConnected)
        return 'Node is detached from document';
      if (element.nodeType !== Node.ELEMENT_NODE)
        return 'Node is not of type HTMLElement';
      return false;
    }
  JAVASCRIPT
  error = evaluate(js) # returns String or false
  if error
    raise ScrollIntoViewError.new(error)
  end
  begin
    @remote_object.scroll_into_view_if_needed(@client)
  rescue => err
    # Fallback to Element.scrollIntoView if DOM.scrollIntoViewIfNeeded is not supported
    js = <<~JAVASCRIPT
      async (element, pageJavascriptEnabled) => {
        const visibleRatio = async () => {
          return await new Promise(resolve => {
            const observer = new IntersectionObserver(entries => {
              resolve(entries[0].intersectionRatio);
              observer.disconnect();
            });
            observer.observe(element);
          });
        };
        if (!pageJavascriptEnabled || (await visibleRatio()) !== 1.0) {
          element.scrollIntoView({
            block: 'center',
            inline: 'center',
            // @ts-expect-error Chrome still supports behavior: instant but
            // it's not in the spec so TS shouts We don't want to make this
            // breaking change in Puppeteer yet so we'll ignore the line.
            behavior: 'instant',
          });
        }
      }
    JAVASCRIPT
    evaluate(js, page.javascript_enabled?)
  end

  # clickpoint is often calculated before scrolling is completed.
  # So, just sleep about 10 frames
  sleep 0.16
end

#select(*values) ⇒ Array<String>

Returns:

  • (Array<String>) 


374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/puppeteer/element_handle.rb', line 374

def select(*values)
  if nonstring = values.find { |value| !value.is_a?(String) }
    raise ArgumentError.new("Values must be strings. Found value \"#{nonstring}\" of type \"#{nonstring.class}\"")
  end

  fn = <<~JAVASCRIPT
  (element, vals) => {
    const values = new Set(vals);
    if (element.nodeName.toLowerCase() !== 'select') {
      throw new Error('Element is not a <select> element.');
    }

    const selectedValues = new Set();
    if (!element.multiple) {
      for (const option of element.options) {
        option.selected = false;
      }
      for (const option of element.options) {
        if (values.has(option.value)) {
          option.selected = true;
          selectedValues.add(option.value);
          break;
        }
      }
    } else {
      for (const option of element.options) {
        option.selected = values.has(option.value);
        if (option.selected) {
          selectedValues.add(option.value);
        }
      }
    }
    element.dispatchEvent(new Event('input', { bubbles: true }));
    element.dispatchEvent(new Event('change', { bubbles: true }));
    return [...selectedValues.values()];
  }
  JAVASCRIPT
  evaluate(fn, values)
end

#Sx(expression) ⇒ Array<ElementHandle>

‘$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.

Parameters:

  • expression (String)

Returns:



630
631
632
633
634
635
636
637
638
639
 
# File 'lib/puppeteer/element_handle.rb', line 630

def Sx(expression)
  param_xpath =
    if expression.start_with?('//')
      ".#{expression}"
    else
      expression
    end

  query_selector_all("xpath/#{param_xpath}")
end

#tap(&block) ⇒ Object 



442
443
444
445
446
447
448
 
# File 'lib/puppeteer/element_handle.rb', line 442

def tap(&block)
  return super(&block) if block

  scroll_into_view_if_needed
  point = clickable_point
  @page.touchscreen.tap(point.x, point.y)
end

#to_element(tag_name) ⇒ Object 



129
130
131
132
133
134
 
# File 'lib/puppeteer/element_handle.rb', line 129

def to_element(tag_name)
  unless evaluate('(node, tagName) => node.nodeName === tagName.toUpperCase()', tag_name)
    raise ArgumentError.new("Element is not a(n) `#{tag_name}` element")
  end
  self
end

#type_text(text, delay: nil) ⇒ Object

Parameters:

  • text (String)
  • delay (number|nil) (defaults to: nil) 


460
461
462
463
 
# File 'lib/puppeteer/element_handle.rb', line 460

def type_text(text, delay: nil)
  focus
  @page.keyboard.type_text(text, delay: delay)
end

#upload_file(*file_paths) ⇒ Object

Parameters:

  • file_paths (Array<String>) 


415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/puppeteer/element_handle.rb', line 415

def upload_file(*file_paths)
  is_multiple = evaluate("el => el.multiple")
  if !is_multiple && file_paths.length >= 2
    raise ArgumentError.new('Multiple file uploads only work with <input type=file multiple>')
  end

  backend_node_id = @remote_object.node_info(@client)["node"]["backendNodeId"]

  # The zero-length array is a special case, it seems that DOM.setFileInputFiles does
  # not actually update the files in that case, so the solution is to eval the element
  # value to a new FileList directly.
  if file_paths.empty?
    fn = <<~JAVASCRIPT
    (element) => {
      element.files = new DataTransfer().files;

      // Dispatch events for this case because it should behave akin to a user action.
      element.dispatchEvent(new Event('input', { bubbles: true }));
      element.dispatchEvent(new Event('change', { bubbles: true }));
    }
    JAVASCRIPT
    await evaluate(fn)
  else
    @remote_object.set_file_input_files(@client, file_paths.map { |path| File.expand_path(path) }, backend_node_id)
  end
end

#wait_for_selector(selector, visible: nil, hidden: nil, timeout: nil) ⇒ Object

Wait for the ‘selector` to appear within the element. If at the moment of calling the method the `selector` already exists, the method will return immediately. If the `selector` doesn’t appear after the ‘timeout` milliseconds of waiting, the function will throw.

This method does not work across navigations or if the element is detached from DOM.

developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors | selector of an element to wait for is added to DOM. Resolves to ‘null` if waiting for hidden: `true` and selector is not found in DOM. The optional parameters in `options` are:

  • ‘visible`: wait for the selected element to be present in DOM and to be

visible, i.e. to not have ‘display: none` or `visibility: hidden` CSS properties. Defaults to `false`.

  • ‘hidden`: wait for the selected element to not be found in the DOM or to be hidden,

i.e. have ‘display: none` or `visibility: hidden` CSS properties. Defaults to `false`.

  • ‘timeout`: maximum time to wait in milliseconds. Defaults to `30000`

(30 seconds). Pass ‘0` to disable timeout. The default value can be changed by using the Page.setDefaultTimeout method.

Parameters:

  • selector —

    • A

  • options —

    • Optional waiting parameters



62
63
64
 
# File 'lib/puppeteer/element_handle.rb', line 62

def wait_for_selector(selector, visible: nil, hidden: nil, timeout: nil)
  query_handler_manager.detect_query_handler(selector).wait_for(self, visible: visible, hidden: hidden, timeout: timeout)
end

#wait_for_xpath(xpath, visible: nil, hidden: nil, timeout: nil) ⇒ Object

Wait for the ‘xpath` within the element. If at the moment of calling the method the `xpath` already exists, the method will return immediately. If the `xpath` doesn’t appear after the ‘timeout` milliseconds of waiting, the function will throw.

If ‘xpath` starts with `//` instead of `.//`, the dot will be appended automatically.

This method works across navigation “‘js const puppeteer = require(’puppeteer’); (async () => { const browser = await puppeteer.launch(); const page = await browser.newPage(); let currentURL; page .waitForXPath(‘//img’) .then(() => console.log(‘First URL with image: ’ + currentURL)); for (currentURL of [ ‘example.com’, ‘google.com’, ‘bbc.com’, ]) { await page.goto(currentURL); } await browser.close(); })(); “‘ developer.mozilla.org/en-US/docs/Web/XPath | xpath of an element to wait for added to DOM. Resolves to `null` if waiting for `hidden: true` and xpath is not found in DOM. The optional Argument `options` have properties:

  • ‘visible`: A boolean to wait for element to be present in DOM and to be

visible, i.e. to not have ‘display: none` or `visibility: hidden` CSS properties. Defaults to `false`.

  • ‘hidden`: A boolean wait for element to not be found in the DOM or to be

hidden, i.e. have ‘display: none` or `visibility: hidden` CSS properties. Defaults to `false`.

  • ‘timeout`: A number which is maximum time to wait for in milliseconds.

Defaults to ‘30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the Page.setDefaultTimeout method.

Parameters:

  • xpath —

    • A

  • options —

    • Optional waiting parameters



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/puppeteer/element_handle.rb', line 116

def wait_for_xpath(xpath, visible: nil, hidden: nil, timeout: nil)
  param_xpath =
    if xpath.start_with?('//')
      ".#{xpath}"
    else
      xpath
    end

  wait_for_selector("xpath/#{param_xpath}", visible: visible, hidden: hidden, timeout: timeout)
end