Capybara::Node::Finders

Public Instance Methods

all(*args) click to toggle source

Find all elements on the page matching the given selector and options.

Both XPath and CSS expressions are supported, but Capybara does not try to automatically distinguish between them. The following statements are equivalent:

page.all(:css, 'a#person_123')
page.all(:xpath, '//a[@id="person_123"]')

If the type of selector is left out, Capybara uses {Capybara.default_selector}. It's set to :css by default.

page.all("a#person_123")

Capybara.default_selector = :xpath
page.all('//a[@id="person_123"]')

The set of found elements can further be restricted by specifying options. It's possible to select elements by their text or visibility:

page.all('a', :text => 'Home')
page.all('#menu li', :visible => true)

@overload all(, locator, options)

@param [:css, :xpath] kind                 The type of selector
@param [String] locator                    The selector
@option options [String, Regexp] text      Only find elements which contain this text or match this regexp
@option options [Boolean] visible          Only find elements that are visible on the page. Setting this to false
                                           (the default, unless Capybara.ignore_hidden_elements = true), finds
                                           invisible _and_ visible elements.

@return [Array] The found elements

# File lib/capybara/node/finders.rb, line 111
def all(*args)
  query = Capybara::Query.new(*args)
  elements = synchronize do
    base.find(query.xpath).map do |node|
      Capybara::Node::Element.new(session, node, self, query)
    end
  end
  Capybara::Result.new(elements, query)
end
field_labeled(locator) click to toggle source
Alias for: find_field
find(*args) click to toggle source

Find an {Capybara::Element} based on the given arguments. find will raise an error if the element is not found. The error message can be customized through the :message option.

If the driver is capable of executing JavaScript, find will wait for a set amount of time and continuously retry finding the element until either the element is found or the time expires. The length of time find will wait is controlled through {Capybara.default_wait_time} and defaults to 2 seconds.

find takes the same options as all.

page.find('#foo').find('.bar')
page.find(:xpath, '//div[contains(., "bar")]')
page.find('li', :text => 'Quox').click_link('Delete')

@param (see Capybara::Node::Finders#all) @option options [String] :message An error message in case the element can't be found @return [Capybara::Element] The found element @raise [Capybara::ElementNotFound] If the element can't be found before time expires

# File lib/capybara/node/finders.rb, line 26
def find(*args)
  synchronize { all(*args).find! }.tap(&:allow_reload!)
end
find_button(locator) click to toggle source

Find a button on the page. The button can be found by its id, name or value.

@param [String] locator Which button to find @return [Capybara::Element] The found element

# File lib/capybara/node/finders.rb, line 60
def find_button(locator)
  find(:button, locator)
end
find_by_id(id) click to toggle source

Find a element on the page, given its id.

@param [String] id Which element to find @return [Capybara::Element] The found element

# File lib/capybara/node/finders.rb, line 71
def find_by_id(id)
  find(:id, id)
end
find_field(locator) click to toggle source

Find a form field on the page. The field can be found by its name, id or label text.

@param [String] locator Which field to find @return [Capybara::Element] The found element

# File lib/capybara/node/finders.rb, line 37
def find_field(locator)
  find(:field, locator)
end
Also aliased as: field_labeled
first(*args) click to toggle source

Find the first element on the page matching the given selector and options, or nil if no element matches.

@overload first(, locator, options)

@param [:css, :xpath] kind                 The type of selector
@param [String] locator                    The selector
@param [Hash] options                      Additional options; see {all}

@return [Capybara::Element] The found element or nil

# File lib/capybara/node/finders.rb, line 132
def first(*args)
  all(*args).first
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.