Module: Capybara::Node::Finders
Instance Method Summary collapse
-
#all([kind], locator, options) ⇒ Array[Capybara::Element]
Find all elements on the page matching the given selector and options.
-
#find(*args) ⇒ Capybara::Element
Find an Element based on the given arguments.
-
#find_button(locator) ⇒ Capybara::Element
Find a button on the page.
-
#find_by_id(id) ⇒ Capybara::Element
Find a element on the page, given its id.
-
#find_field(locator) ⇒ Capybara::Element
(also: #field_labeled)
Find a form field on the page.
-
#find_link(locator) ⇒ Capybara::Element
Find a link on the page.
-
#first([kind], locator, options) ⇒ Capybara::Element
Find the first element on the page matching the given selector and options, or nil if no element matches.
Instance Method Details
#all([kind], locator, options) ⇒ Array[Capybara::Element]
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)
110 111 112 113 114 115 116 117 118 |
# File 'lib/capybara/node/finders.rb', line 110 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 |
#find(*args) ⇒ Capybara::Element
Find an Element based on the given arguments. find
will raise an error if the element is not found.
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')
25 26 27 |
# File 'lib/capybara/node/finders.rb', line 25 def find(*args) synchronize { all(*args).find! }.tap(&:allow_reload!) end |
#find_button(locator) ⇒ Capybara::Element
Find a button on the page. The button can be found by its id, name or value.
59 60 61 |
# File 'lib/capybara/node/finders.rb', line 59 def (locator) find(:button, locator) end |
#find_by_id(id) ⇒ Capybara::Element
Find a element on the page, given its id.
70 71 72 |
# File 'lib/capybara/node/finders.rb', line 70 def find_by_id(id) find(:id, id) end |
#find_field(locator) ⇒ Capybara::Element Also known as: field_labeled
Find a form field on the page. The field can be found by its name, id or label text.
36 37 38 |
# File 'lib/capybara/node/finders.rb', line 36 def find_field(locator) find(:field, locator) end |
#find_link(locator) ⇒ Capybara::Element
Find a link on the page. The link can be found by its id or text.
48 49 50 |
# File 'lib/capybara/node/finders.rb', line 48 def find_link(locator) find(:link, locator) end |
#first([kind], locator, options) ⇒ Capybara::Element
Find the first element on the page matching the given selector and options, or nil if no element matches.
131 132 133 |
# File 'lib/capybara/node/finders.rb', line 131 def first(*args) all(*args).first end |