Module: Selenium::WebDriver::KeyActions

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: `ActionBuilder`
Defined in:	rb/lib/selenium/webdriver/common/interactions/key_actions.rb

Instance Method Summary

#key_down(key, device: nil) ⇒ ActionBuilder

Performs a key press.
#key_up(key, device: nil) ⇒ ActionBuilder

Performs a key release.
#send_keys(keys, device: nil) ⇒ ActionBuilder

Sends keys to the active element.
#key_input(name = nil) private
#key_down(key, action: nil, device: nil) ⇒ ActionBuilder private Internal use only Internal use only

Instance Method Details

#key_down(key, action: nil, device: nil) ⇒ ActionBuilder (private) #key_down(element, key, action: nil, device: nil) ⇒ ActionBuilder

This method is for internal use only.

Parameters:

args (Array)
action (Symbol) —

The name of the key action to perform
device (Symbol, String) —

optional name of the KeyInput device to press the key on

Options Hash (*args):

element (Element) —

An optional element to move to first
key (Symbol, String) —

The key to perform the action with

Returns:

(ActionBuilder) —

A self reference

[ GitHub ]

# File 'rb/lib/selenium/webdriver/common/interactions/key_actions.rb', line 136


def key_action(*args, action: nil, device: nil)
  key_input = key_input(device)
  click(args.shift) if args.first.is_a? Element
  key_input.send(action, args.last)
  tick(key_input)
  self
end

#key_down(key, device: nil) ⇒ ActionBuilder #key_down(element, key, device: nil) ⇒ ActionBuilder

Performs a key press. Does not release the key - subsequent interactions may assume it’s kept pressed. Note that the key is never released implicitly - either ActionBuilder#key_up(key) or ActionBuilder#release_actions must be called to release the key.

Examples:

Press a key

driver.action.key_down(:control).perform

Press a key on an element

el = driver.find_element(id: "some_id")
driver.action.key_down(el, :shift).perform

Returns:

(ActionBuilder) —

A self reference

[ GitHub ]

# File 'rb/lib/selenium/webdriver/common/interactions/key_actions.rb', line 47


def key_down(*args, device: nil)
  key_action(*args, action: :create_key_down, device: device)
end

#key_input(name = nil) (private)

[ GitHub ]

# File 'rb/lib/selenium/webdriver/common/interactions/key_actions.rb', line 144


def key_input(name = nil)
  device(name: name, type: Interactions::KEY) || add_key_input('keyboard')
end

#key_up(key, device: nil) ⇒ ActionBuilder #key_up(element, key, device: nil) ⇒ ActionBuilder

Performs a key release. Releasing a non-depressed key will yield undefined behaviour.

Examples:

Release a key

driver.action.key_up(:shift).perform

Release a key from an element

el = driver.find_element(id: "some_id")
driver.action.key_up(el, :alt).perform

Returns:

(ActionBuilder) —

A self reference

[ GitHub ]

# File 'rb/lib/selenium/webdriver/common/interactions/key_actions.rb', line 74


def key_up(*args, device: nil)
  key_action(*args, action: :create_key_up, device: device)
end

#send_keys(keys, device: nil) ⇒ ActionBuilder #send_keys(element, keys, device: nil) ⇒ ActionBuilder

Sends keys to the active element. This differs from calling Element#send_keys(keys) on the active element in two ways:

The modifier keys included in this call are not released.
There is no attempt to re-focus the element - so send_keys(:tab) for switching elements should work.

Examples:

Send the text “help” to an element

el = driver.find_element(id: "some_id")
driver.action.send_keys(el, "help").perform

Send the text “help” to the currently focused element

driver.action.send_keys("help").perform

Returns:

(ActionBuilder) —

A self reference

[ GitHub ]

# File 'rb/lib/selenium/webdriver/common/interactions/key_actions.rb', line 104


def send_keys(*args, device: nil)
  click(args.shift) if args.first.is_a? Element
  args.map { |x| x.is_a?(String) ? x.chars : x }.flatten.each do |arg|
    key_down(arg, device: device)
    key_up(arg, device: device)
  end
  self
end