class Capybara::Node::Element
A {Capybara::Node::Element} represents a single element on the page. It is possible to interact with the contents of this element the same as with a document:
session = Capybara::Session.new(:rack_test, my_app) bar = session.find('#bar') # from Capybara::Node::Finders bar.select('Baz', :from => 'Quox') # from Capybara::Node::Actions
{Capybara::Node::Element} also has access to HTML attributes and other properties of the element:
bar.value bar.text bar[:title]
@see Capybara::Node
Public Class Methods
# File lib/capybara/node/element.rb, line 26 def initialize(session, base, parent, query) super(session, base) @parent = parent @query = query end
Public Instance Methods
Retrieve the given attribute
element[:title] # => HTML title attribute
@param [Symbol] attribute The attribute to retrieve @return [String] The value of the attribute
# File lib/capybara/node/element.rb, line 76 def [](attribute) synchronize { base[attribute] } end
# File lib/capybara/node/element.rb, line 32 def allow_reload! @allow_reload = true end
Whether or not the element is checked.
@return [Boolean] Whether the element is checked
# File lib/capybara/node/element.rb, line 261 def checked? synchronize { base.checked? } end
Click the Element
# File lib/capybara/node/element.rb, line 134 def click synchronize { base.click } end
Whether or not the element is disabled.
@return [Boolean] Whether the element is disabled
# File lib/capybara/node/element.rb, line 281 def disabled? synchronize { base.disabled? } end
Double Click the Element
# File lib/capybara/node/element.rb, line 150 def double_click synchronize { base.double_click } end
Drag the element to the given other element.
source = page.find('#foo') target = page.find('#bar') source.drag_to(target)
@param [Capybara::Node::Element] node The element to drag to
# File lib/capybara/node/element.rb, line 316 def drag_to(node) synchronize { base.drag_to(node.base) } end
Hover on the Element
# File lib/capybara/node/element.rb, line 232 def hover synchronize { base.hover } end
# File lib/capybara/node/element.rb, line 332 def inspect %Q(#<Capybara::Node::Element tag="#{tag_name}" path="#{path}">) rescue NotSupportedByDriverError %Q(#<Capybara::Node::Element tag="#{tag_name}">) end
@return [Object] The native element from the driver, this allows access to driver specific methods
# File lib/capybara/node/element.rb, line 40 def native synchronize { base.native } end
# File lib/capybara/node/element.rb, line 320 def reload if @allow_reload begin reloaded = parent.reload.first(@query.name, @query.locator, @query.options) @base = reloaded.base if reloaded rescue => e raise e unless catch_error?(e) end end self end
Right Click the Element
# File lib/capybara/node/element.rb, line 142 def right_click synchronize { base.right_click } end
Select this node if is an option element inside a select tag
# File lib/capybara/node/element.rb, line 117 def select_option warn "Attempt to select disabled option: #{value || text}" if disabled? synchronize { base.select_option } end
Whether or not the element is selected.
@return [Boolean] Whether the element is selected
# File lib/capybara/node/element.rb, line 271 def selected? synchronize { base.selected? } end
Send Keystrokes to the Element
@overload #send_keys(keys, …)
@param [String, Symbol, Array<String,Symbol>] keys
Examples:
element.send_keys "foo" #=> value: 'foo' element.send_keys "tet", :left, "s" #=> value: 'test' element.send_keys [:control, 'a'], :space #=> value: ' ' - assuming ctrl-a selects all contents
Symbols supported for keys :cancel :help :backspace :tab :clear :return :enter :shift :control :alt :pause :escape :space :page_up :page_down :end :home :left :up :right :down :insert :delete :semicolon :equals :numpad0 :numpad1 :numpad2 :numpad3 :numpad4 :numpad5 :numpad6 :numpad7 :numpad8 :numpad9 :multiply - numeric keypad * :add - numeric keypad + :separator - numeric keypad 'separator' key ?? :subtract - numeric keypad - :decimal - numeric keypad . :divide - numeric keypad / :f1 :f2 :f3 :f4 :f5 :f6 :f7 :f8 :f9 :f10 :f11 :f12 :meta :command - alias of :meta
# File lib/capybara/node/element.rb, line 224 def send_keys(*args) synchronize { base.send_keys(*args) } end
Set the value of the form element to the given value.
@param [String] value The new value @param [Hash{}] options Driver specific options for how to set the value
# File lib/capybara/node/element.rb, line 95 def set(value, options={}) options ||= {} driver_supports_options = (base.method(:set).arity != 1) unless options.empty? || driver_supports_options warn "Options passed to Capybara::Node#set but the driver doesn't support them" end synchronize do if driver_supports_options base.set(value, options) else base.set(value) end end end
@return [String] The tag name of the element
# File lib/capybara/node/element.rb, line 240 def tag_name synchronize { base.tag_name } end
Retrieve the text of the element. If `Capybara.ignore_hidden_elements` is `true`, which it is by default, then this will return only text which is visible. The exact semantics of this may differ between drivers, but generally any text within elements with `display:none` is ignored. This behaviour can be overridden by passing `:all` to this method.
@param [:all, :visible] type Whether to return only visible or all text @return [String] The text of the element
# File lib/capybara/node/element.rb, line 56 def text(type=nil) type ||= :all unless Capybara.ignore_hidden_elements or Capybara.visible_text_only synchronize do if type == :all base.all_text else base.visible_text end end end
Trigger any event on the current element, for example mouseover or focus events. Does not work in Selenium.
@param [String] event The name of the event to trigger
# File lib/capybara/node/element.rb, line 302 def trigger(event) synchronize { base.trigger(event) } end
Unselect this node if is an option element inside a multiple select tag
# File lib/capybara/node/element.rb, line 126 def unselect_option synchronize { base.unselect_option } end
@return [String] The value of the form element
# File lib/capybara/node/element.rb, line 84 def value synchronize { base.value } end
Whether or not the element is visible. Not all drivers support CSS, so the result may be inaccurate.
@return [Boolean] Whether the element is visible
# File lib/capybara/node/element.rb, line 251 def visible? synchronize { base.visible? } end