Class: Puppeteer::ElementHandle
- Inherits:
-
JSHandle
- Object
- JSHandle
- Puppeteer::ElementHandle
show all
- Includes:
- DebugPrint, IfPresent
- Defined in:
- lib/puppeteer/element_handle.rb,
lib/puppeteer/element_handle/point.rb,
lib/puppeteer/element_handle/box_model.rb,
lib/puppeteer/element_handle/bounding_box.rb
Defined Under Namespace
Classes: BoundingBox, BoxModel, ElementNotFoundError, ElementNotVisibleError, Point, ScrollIntoViewError
Instance Attribute Summary
Attributes inherited from JSHandle
#context, #remote_object
Instance Method Summary
collapse
-
#as_element ⇒ Object
-
#bounding_box ⇒ BoundingBox|nil
-
#box_model ⇒ BoxModel|nil
-
#click(delay: nil, button: nil, click_count: nil) ⇒ Object
-
#clickable_point ⇒ Object
-
#content_frame ⇒ Object
-
#focus ⇒ Object
-
#hover ⇒ Object
-
#initialize(context:, client:, remote_object:, page:, frame_manager:) ⇒ ElementHandle
constructor
A new instance of ElementHandle.
-
#intersecting_viewport? ⇒ Boolean
in JS, #isIntersectingViewport.
-
#press(key, delay: nil, text: nil) ⇒ Object
-
#S(selector) ⇒ Object
-
#screenshot(options = {}) ⇒ Object
-
#scroll_into_view_if_needed ⇒ Object
-
#select(*values) ⇒ Array<String>
-
#Seval(selector, page_function, *args) ⇒ Object
-
#SS(selector) ⇒ Object
-
#SSeval(selector, page_function, *args) ⇒ Object
‘$$eval()` in JavaScript.
-
#Sx(expression) ⇒ Array<ElementHandle>
-
#tap(&block) ⇒ Object
-
#type_text(text, delay: nil) ⇒ Object
-
#upload_file(*file_paths) ⇒ Object
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:, page:, frame_manager:) ⇒ ElementHandle
Returns a new instance of ElementHandle.
15
16
17
18
19
20
|
# File 'lib/puppeteer/element_handle.rb', line 15
def initialize(context:, client:, remote_object:, page:, frame_manager:)
super(context: context, client: client, remote_object: remote_object)
@page = page
@frame_manager = frame_manager
@disposed = false
end
|
Instance Method Details
#as_element ⇒ Object
22
23
24
|
# File 'lib/puppeteer/element_handle.rb', line 22
def as_element
self
end
|
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
# File 'lib/puppeteer/element_handle.rb', line 229
def bounding_box
if_present(box_model) do |result_model|
quads = result_model.border
x = quads.map(&:x).min
y = quads.map(&:y).min
BoundingBox.new(
x: x,
y: y,
width: quads.map(&:x).max - x,
height: quads.map(&:y).max - y,
)
end
end
|
#box_model ⇒ BoxModel|nil
245
246
247
248
249
|
# File 'lib/puppeteer/element_handle.rb', line 245
def box_model
if_present(@remote_object.box_model(@client)) do |result|
BoxModel.new(result['model'])
end
end
|
#click(delay: nil, button: nil, click_count: nil) ⇒ Object
125
126
127
128
129
|
# File 'lib/puppeteer/element_handle.rb', line 125
def click(delay: nil, button: nil, click_count: nil)
scroll_into_view_if_needed
point = clickable_point
@page.mouse.click(point.x, point.y, delay: delay, button: button, click_count: click_count)
end
|
#clickable_point ⇒ Object
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
# File 'lib/puppeteer/element_handle.rb', line 65
def clickable_point
result =
begin
@remote_object.content_quads(@client)
rescue => err
debug_puts(err)
nil
end
if !result || result["quads"].empty?
raise ElementNotVisibleError.new
end
layout_metrics = @client.send_message('Page.getLayoutMetrics')
client_width = layout_metrics["layoutViewport"]["clientWidth"]
client_height = layout_metrics["layoutViewport"]["clientHeight"]
quads = result["quads"].
map { |quad| from_protocol_quad(quad) }.
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
quads.first.reduce(:+) / 4
end
|
#content_frame ⇒ Object
26
27
28
29
30
31
32
33
34
|
# File 'lib/puppeteer/element_handle.rb', line 26
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
|
#focus ⇒ Object
203
204
205
|
# File 'lib/puppeteer/element_handle.rb', line 203
def focus
evaluate('element => element.focus()')
end
|
#hover ⇒ Object
116
117
118
119
120
|
# File 'lib/puppeteer/element_handle.rb', line 116
def hover
scroll_into_view_if_needed
point = clickable_point
@page.mouse.move(point.x, point.y)
end
|
#intersecting_viewport? ⇒ Boolean
in JS, #isIntersectingViewport.
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
|
# File 'lib/puppeteer/element_handle.rb', line 393
def intersecting_viewport?
js = <<~JAVASCRIPT
async element => {
const visibleRatio = await new Promise(resolve => {
const observer = new IntersectionObserver(entries => {
resolve(entries[0].intersectionRatio);
observer.disconnect();
});
observer.observe(element);
});
return visibleRatio > 0;
}
JAVASCRIPT
evaluate(js)
end
|
#press(key, delay: nil, text: nil) ⇒ Object
221
222
223
224
|
# File 'lib/puppeteer/element_handle.rb', line 221
def press(key, delay: nil, text: nil)
focus
@page.keyboard.press(key, delay: delay, text: text)
end
|
#S(selector) ⇒ Object
‘$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
302
303
304
305
306
307
308
309
310
311
312
313
314
|
# File 'lib/puppeteer/element_handle.rb', line 302
def S(selector)
handle = evaluate_handle(
'(element, selector) => element.querySelector(selector)',
selector,
)
element = handle.as_element
if element
return element
end
handle.dispose
nil
end
|
#screenshot(options = {}) ⇒ Object
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
292
293
294
295
296
297
298
|
# File 'lib/puppeteer/element_handle.rb', line 251
def screenshot(options = {})
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"]
clip = {
x: page_x + box.x,
y: page_y + box.y,
width: box.width,
height: box.height,
}
@page.screenshot({ clip: clip }.merge(options))
ensure
if needs_viewport_reset
@page.viewport = viewport
end
end
|
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
# File 'lib/puppeteer/element_handle.rb', line 38
def scroll_into_view_if_needed
js = <<~JAVASCRIPT
async(element, pageJavascriptEnabled) => {
if (!element.isConnected)
return 'Node is detached from document';
if (element.nodeType !== Node.ELEMENT_NODE)
return 'Node is not of type HTMLElement';
element.scrollIntoViewIfNeeded({block: 'center', inline: 'center', behavior: 'instant'});
return false;
}
JAVASCRIPT
error = evaluate(js, @page.javascript_enabled) if error
raise ScrollIntoViewError.new(error)
end
sleep 0.16
end
|
#select(*values) ⇒ Array<String>
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
# File 'lib/puppeteer/element_handle.rb', line 134
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, values) => {
if (element.nodeName.toLowerCase() !== 'select') {
throw new Error('Element is not a <select> element.');
}
const options = Array.from(element.options);
element.value = undefined;
for (const option of options) {
option.selected = values.includes(option.value);
if (option.selected && !element.multiple) {
break;
}
}
element.dispatchEvent(new Event('input', { bubbles: true }));
element.dispatchEvent(new Event('change', { bubbles: true }));
return options.filter(option => option.selected).map(option => option.value);
}
JAVASCRIPT
evaluate(fn, values)
end
|
#Seval(selector, page_function, *args) ⇒ Object
‘$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
338
339
340
341
342
343
344
345
346
347
|
# File 'lib/puppeteer/element_handle.rb', line 338
def Seval(selector, page_function, *args)
element_handle = S(selector)
unless element_handle
raise ElementNotFoundError.new(selector)
end
result = element_handle.evaluate(page_function, *args)
element_handle.dispose
result
end
|
#SS(selector) ⇒ Object
‘$$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
318
319
320
321
322
323
324
325
326
|
# File 'lib/puppeteer/element_handle.rb', line 318
def SS(selector)
handles = evaluate_handle(
'(element, selector) => element.querySelectorAll(selector)',
selector,
)
properties = handles.properties
handles.dispose
properties.values.map(&:as_element).compact
end
|
#SSeval(selector, page_function, *args) ⇒ Object
‘$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
355
356
357
358
359
360
361
362
363
364
|
# File 'lib/puppeteer/element_handle.rb', line 355
def SSeval(selector, page_function, *args)
handles = evaluate_handle(
'(element, selector) => Array.from(element.querySelectorAll(selector))',
selector,
)
result = handles.evaluate(page_function, *args)
handles.dispose
result
end
|
‘$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
|
# File 'lib/puppeteer/element_handle.rb', line 371
def Sx(expression)
fn = <<~JAVASCRIPT
(element, expression) => {
const document = element.ownerDocument || element;
const iterator = document.evaluate(expression, element, null, XPathResult.ORDERED_NODE_ITERATOR_TYPE);
const array = [];
let item;
while ((item = iterator.iterateNext()))
array.push(item);
return array;
}
JAVASCRIPT
handles = evaluate_handle(fn, expression)
properties = handles.properties
handles.dispose
properties.values.map(&:as_element).compact
end
|
#tap(&block) ⇒ Object
193
194
195
196
197
198
199
|
# File 'lib/puppeteer/element_handle.rb', line 193
def tap(&block)
return super(&block) if block
scroll_into_view_if_needed
point = clickable_point
@page.touchscreen.tap(point.x, point.y)
end
|
#type_text(text, delay: nil) ⇒ Object
211
212
213
214
|
# File 'lib/puppeteer/element_handle.rb', line 211
def type_text(text, delay: nil)
focus
@page.keyboard.type_text(text, delay: delay)
end
|
#upload_file(*file_paths) ⇒ Object
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
|
# File 'lib/puppeteer/element_handle.rb', line 162
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
if error_path = file_paths.find { |file_path| !File.exist?(file_path) }
raise ArgmentError.new("#{error_path} does not exist or is not readable")
end
backend_node_id = @remote_object.node_info(@client)["node"]["backendNodeId"]
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 this.evaluate(fn)
else
@remote_object.set_file_input_files(@client, file_paths, backend_node_id)
end
end
|