Class: Playwright::ChannelOwners::ElementHandle

Inherits:
JSHandle show all
Defined in:
lib/playwright/channel_owners/element_handle.rb

Instance Method Summary collapse

Methods inherited from JSHandle

#dispose, #evaluate, #evaluate_handle, #get_properties, #get_property, #json_value, #off, #on, #once, #to_s

Methods inherited from PlaywrightApi

#initialize, unwrap, wrap

Constructor Details

This class inherits a constructor from Playwright::PlaywrightApi

Instance Method Details

#as_element ⇒ Object 



11
12
13
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 11

def as_element
  self
end

#bounding_box ⇒ Object 



296
297
298
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 296

def bounding_box
  @channel.send_message_to_server('boundingBox')
end

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



262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 262

def check(force: nil, noWaitAfter: nil, position: nil, timeout: nil, trial: nil)
  params = {
    force: force,
    noWaitAfter:  noWaitAfter,
    position: position,
    timeout: _timeout(timeout),
    trial: trial,
  }.compact
  @channel.send_message_to_server('check', params)

  nil
end

#checked? ⇒ Boolean 



41
42
43
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 41

def checked?
  @channel.send_message_to_server('isChecked')
end

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 104

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

  params = {
    button: button,
    clickCount: clickCount,
    delay: delay,
    force: force,
    modifiers: modifiers,
    noWaitAfter: noWaitAfter,
    position: position,
    timeout: _timeout(timeout),
    trial: trial,
  }.compact
  @channel.send_message_to_server('click', params)

  nil
end

#content_frame ⇒ Object 



20
21
22
23
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 20

def content_frame
  resp = @channel.send_message_to_server('contentFrame')
  ChannelOwners::Frame.from_nullable(resp)
end

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 131

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

  params = {
    button: button,
    delay: delay,
    force: force,
    modifiers: modifiers,
    noWaitAfter: noWaitAfter,
    position: position,
    timeout: _timeout(timeout),
    trial: trial,
  }.compact
  @channel.send_message_to_server('dblclick', params)

  nil
end

#disabled? ⇒ Boolean 



45
46
47
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 45

def disabled?
  @channel.send_message_to_server('isDisabled')
end

#dispatch_event(type, eventInit: nil) ⇒ Object 



65
66
67
68
69
70
71
72
73
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 65

def dispatch_event(type, eventInit: nil)
  params = {
    type: type,
    eventInit: JavaScript::ValueSerializer.new(eventInit).serialize,
  }.compact
  @channel.send_message_to_server('dispatchEvent', params)

  nil
end

#editable? ⇒ Boolean 



49
50
51
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 49

def editable?
  @channel.send_message_to_server('isEditable')
end

#enabled? ⇒ Boolean 



53
54
55
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 53

def enabled?
  @channel.send_message_to_server('isEnabled')
end

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



351
352
353
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 351

def eval_on_selector(selector, pageFunction, arg: nil)
  JavaScript::Expression.new(pageFunction, arg).eval_on_selector(@channel, selector)
end

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



355
356
357
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 355

def eval_on_selector_all(selector, pageFunction, arg: nil)
  JavaScript::Expression.new(pageFunction, arg).eval_on_selector_all(@channel, selector)
end

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



195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 195

def fill(value, force: nil, noWaitAfter: nil, timeout: nil)
  params = {
    value: value,
    force: force,
    noWaitAfter: noWaitAfter,
    timeout: _timeout(timeout),
  }.compact
  @channel.send_message_to_server('fill', params)

  nil
end

#focus ⇒ Object 



232
233
234
235
236
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 232

def focus
  @channel.send_message_to_server('focus')

  nil
end

#get_attribute(name) ⇒ Object 



25
26
27
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 25

def get_attribute(name)
  @channel.send_message_to_server('getAttribute', name: name)
end

#hidden? ⇒ Boolean 



57
58
59
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 57

def hidden?
  @channel.send_message_to_server('isHidden')
end

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 84

def hover(
      force: nil,
      modifiers: nil,
      noWaitAfter: nil,
      position: nil,
      timeout: nil,
      trial: nil)
  params = {
    force: force,
    modifiers: modifiers,
    noWaitAfter: noWaitAfter,
    position: position,
    timeout: _timeout(timeout),
    trial: trial,
  }.compact
  @channel.send_message_to_server('hover', params)

  nil
end

#inner_html ⇒ Object 



37
38
39
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 37

def inner_html
  @channel.send_message_to_server('innerHTML')
end

#inner_text ⇒ Object 



33
34
35
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 33

def inner_text
  @channel.send_message_to_server('innerText')
end

#input_value(timeout: nil) ⇒ Object 



214
215
216
217
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 214

def input_value(timeout: nil)
  params = { timeout: _timeout(timeout) }.compact
  @channel.send_message_to_server('inputValue', params)
end

#owner_frame ⇒ Object 



15
16
17
18
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 15

def owner_frame
  resp = @channel.send_message_to_server('ownerFrame')
  ChannelOwners::Frame.from_nullable(resp)
end

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



250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 250

def press(key, delay: nil, noWaitAfter: nil, timeout: nil)
  params = {
    key: key,
    delay: delay,
    noWaitAfter: noWaitAfter,
    timeout: _timeout(timeout),
  }.compact
  @channel.send_message_to_server('press', params)

  nil
end

#query_selector(selector) ⇒ Object 



340
341
342
343
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 340

def query_selector(selector)
  resp = @channel.send_message_to_server('querySelector', selector: selector)
  ChannelOwners::ElementHandle.from_nullable(resp)
end

#query_selector_all(selector) ⇒ Object 



345
346
347
348
349
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 345

def query_selector_all(selector)
  @channel.send_message_to_server('querySelectorAll', selector: selector).map do |el|
    ChannelOwners::ElementHandle.from(el)
  end
end

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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 300

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

  params = {
    animations: animations,
    caret: caret,
    maskColor: maskColor,
    omitBackground: omitBackground,
    path: path,
    quality: quality,
    scale: scale,
    style: style,
    timeout: _timeout(timeout),
    type: type,
  }.compact
  if mask.is_a?(Enumerable)
    params[:mask] = mask.map do |locator|
      locator.send(:to_protocol)
    end
  end
  encoded_binary = @channel.send_message_to_server('screenshot', params)
  decoded_binary = Base64.strict_decode64(encoded_binary)
  if path
    File.open(path, 'wb') do |f|
      f.write(decoded_binary)
    end
  end
  decoded_binary
end

#scroll_into_view_if_needed(timeout: nil) ⇒ Object 



75
76
77
78
79
80
81
82
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 75

def scroll_into_view_if_needed(timeout: nil)
  params = {
    timeout: _timeout(timeout),
  }.compact
  @channel.send_message_to_server('scrollIntoViewIfNeeded', params)

  nil
end

#select_option(element: nil, index: nil, value: nil, label: nil, force: nil, noWaitAfter: nil, timeout: nil) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 156

def select_option(
      element: nil,
      index: nil,
      value: nil,
      label: nil,
      force: nil,
      noWaitAfter: nil,
      timeout: nil)
  base_params = SelectOptionValues.new(
    element: element,
    index: index,
    value: value,
    label: label,
  ).as_params
  params = base_params.merge({ force: force, noWaitAfter: noWaitAfter, timeout: _timeout(timeout) }.compact)
  @channel.send_message_to_server('selectOption', params)
end

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



207
208
209
210
211
212
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 207

def select_text(force: nil, timeout: nil)
  params = { force: force, timeout: _timeout(timeout) }.compact
  @channel.send_message_to_server('selectText', params)

  nil
end

#set_checked(checked, **options) ⇒ Object 



288
289
290
291
292
293
294
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 288

def set_checked(checked, **options)
  if checked
    check(**options)
  else
    uncheck(**options)
  end
end

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



219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 219

def set_input_files(files, noWaitAfter: nil, timeout: nil)
  frame = owner_frame
  unless frame
    raise 'Cannot set input files to detached element'
  end

  method_name, params = InputFiles.new(frame.page.context, files).as_method_and_params
  params.merge!({ noWaitAfter: noWaitAfter, timeout: _timeout(timeout) }.compact)
  @channel.send_message_to_server(method_name, params)

  nil
end

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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 174

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

  params = {
    force: force,
    modifiers: modifiers,
    noWaitAfter: noWaitAfter,
    position: position,
    timeout: _timeout(timeout),
    trial: trial,
  }.compact
  @channel.send_message_to_server('tap', params)

  nil
end

#text_content ⇒ Object 



29
30
31
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 29

def text_content
  @channel.send_message_to_server('textContent')
end

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



238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 238

def type(text, delay: nil, noWaitAfter: nil, timeout: nil)
  params = {
    text: text,
    delay: delay,
    noWaitAfter: noWaitAfter,
    timeout: _timeout(timeout),
  }.compact
  @channel.send_message_to_server('type', params)

  nil
end

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



275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 275

def uncheck(force: nil, noWaitAfter: nil, position: nil, timeout: nil, trial: nil)
  params = {
    force: force,
    noWaitAfter:  noWaitAfter,
    position: position,
    timeout: _timeout(timeout),
    trial: trial,
  }.compact
  @channel.send_message_to_server('uncheck', params)

  nil
end

#visible? ⇒ Boolean 



61
62
63
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 61

def visible?
  @channel.send_message_to_server('isVisible')
end

#wait_for_element_state(state, timeout: nil) ⇒ Object 



359
360
361
362
363
364
 
# File 'lib/playwright/channel_owners/element_handle.rb', line 359

def wait_for_element_state(state, timeout: nil)
  params = { state: state, timeout: _timeout(timeout) }.compact
  @channel.send_message_to_server('waitForElementState', params)

  nil
end

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



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

def wait_for_selector(selector, state: nil, strict: nil, timeout: nil)
  params = { selector: selector, state: state, strict: strict, timeout: _timeout(timeout) }.compact
  resp = @channel.send_message_to_server('waitForSelector', params)

  ChannelOwners::ElementHandle.from_nullable(resp)
end