kotovalexarian-likes-github
/
teamcapybara--capybara
mirror of https://github.com/teamcapybara/capybara.git
1
0
Fork 0
Code Releases Activity

Documentation updates [ci skip]

This commit is contained in:
Thomas Walpole 2018-10-28 12:00:34 -07:00
parent 646db862e7
commit 5c057d7f5f
2 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
lib/capybara/node/actions.rb
View File

@ -78,10 +78,10 @@ module Capybara
# @macro waiting_behavior
# @option options [String] currently_with The current value property of the field to fill in
# @option options [Boolean] multiple Match fields that can have multiple values?
# @option options [String] id Match fields that match the id attribute
# @option options [String, Regexp] id Match fields that match the id attribute
# @option options [String] name Match fields that match the name attribute
# @option options [String] placeholder Match fields that match the placeholder attribute
# @option options [String, Array<String>] class Match fields that match the class(es) provided
# @option options [String, Array<String>, Regexp] class Match fields that match the class(es) provided
# @option options [Hash] fill_options Driver specific options regarding how to fill fields (Defaults come from Capybara.default_set_options)
#
# @return [Capybara::Node::Element] The element filled_in
@ -110,9 +110,9 @@ module Capybara
# @param [String] locator Which radio button to choose
#
# @option options [String] option Value of the radio_button to choose
# @option options [String] id Match fields that match the id attribute
# @option options [String, Regexp] id Match fields that match the id attribute
# @option options [String] name Match fields that match the name attribute
# @option options [String, Array<String>] class Match fields that match the class(es) provided
# @option options [String, Array<String>, Regexp] class Match fields that match the class(es) provided
# @macro waiting_behavior
# @macro label_click
#
@ -138,9 +138,9 @@ module Capybara
# @param [String] locator Which check box to check
#
# @option options [String] option Value of the checkbox to select
# @option options [String] id Match fields that match the id attribute
# @option options [String, Regexp] id Match fields that match the id attribute
# @option options [String] name Match fields that match the name attribute
# @option options [String, Array<String>] class Match fields that match the class(es) provided
# @option options [String, Array<String>, Regexp] class Match fields that match the class(es) provided
# @macro label_click
# @macro waiting_behavior
#
@ -166,9 +166,9 @@ module Capybara
# @param [String] locator Which check box to uncheck
#
# @option options [String] option Value of the checkbox to deselect
# @option options [String] id Match fields that match the id attribute
# @option options [String, Regexp] id Match fields that match the id attribute
# @option options [String] name Match fields that match the name attribute
# @option options [String, Array<String>] class Match fields that match the class(es) provided
# @option options [String, Array<String>, Regexp] class Match fields that match the class(es) provided
# @macro label_click
# @macro waiting_behavior
#
@ -246,9 +246,9 @@ module Capybara
# @option options [Symbol] match (Capybara.match) The matching strategy to use (:one, :first, :prefer_exact, :smart).
# @option options [Boolean] exact (Capybara.exact) Match the exact label name/contents or accept a partial match.
# @option options [Boolean] multiple Match field which allows multiple file selection
# @option options [String] id Match fields that match the id attribute
# @option options [String, Regexp] id Match fields that match the id attribute
# @option options [String] name Match fields that match the name attribute
# @option options [String, Array<String>] class Match fields that match the class(es) provided
# @option options [String, Array<String>, Regexp] class Match fields that match the class(es) provided
# @option options [true, Hash] make_visible A Hash of CSS styles to change before attempting to attach the file, if `true` { opacity: 1, display: 'block', visibility: 'visible' } is used (may not be supported by all drivers)
#
# @return [Capybara::Node::Element] The file field element

14
lib/capybara/node/finders.rb
View File

@ -118,10 +118,10 @@ module Capybara
# @option options [String, Regexp] with Value of field to match on
# @option options [String] type Type of field to match on
# @option options [Boolean] multiple Match fields that can have multiple values?
# @option options [String] id Match fields that match the id attribute
# @option options [String, Regexp] id Match fields that match the id attribute
# @option options [String] name Match fields that match the name attribute
# @option options [String] placeholder Match fields that match the placeholder attribute
# @option options [String, Array<String>] Match fields that match the class(es) passed
# @option options [String, Array<String>, Regexp] class Match fields that match the class(es) passed
# @return [Capybara::Node::Element] The found element
#
@ -139,10 +139,10 @@ module Capybara
# @macro waiting_behavior
#
# @option options [String,Regexp,nil] href Value to match against the links href, if nil finds link placeholders (<a> elements with no href attribute)
# @option options [String] id Match links with the id provided
# @option options [String, Regexp] id Match links with the id provided
# @option options [String] title Match links with the title provided
# @option options [String] alt Match links with a contained img element whose alt matches
# @option options [String, Array<String>] class Match links that match the class(es) provided
# @option options [String, Array<String>, Regexp] class Match links that match the class(es) provided
# @return [Capybara::Node::Element] The found element
#
def find_link(locator = nil, **options, &optional_filter_block)
@ -167,10 +167,10 @@ module Capybara
# * true - only finds a disabled button
# * false - only finds an enabled button
# * :all - finds either an enabled or disabled button
# @option options [String] id Match buttons with the id provided
# @option options [String, Regexp] id Match buttons with the id provided
# @option options [String] title Match buttons with the title provided
# @option options [String] value Match buttons with the value provided
# @option options [String, Array<String>] class Match buttons that match the class(es) provided
# @option options [String, Array<String>, Regexp] class Match buttons that match the class(es) provided
# @return [Capybara::Node::Element] The found element
#
def find_button(locator = nil, **options, &optional_filter_block)
@ -275,7 +275,7 @@ module Capybara
# element is found, or `nil` if the provided count options allow for empty results.
#
# @overload first([kind], locator, options)
# @param [:css, :xpath] kind The type of selector
# @param [Symbol] kind The type of selector
# @param [String] locator The selector
# @param [Hash] options Additional options; see {#all}
# @return [Capybara::Node::Element] The found element or nil