module Watir::EventuallyPresent

Convenience methods for things that eventually become present.

Includers should implement a public present? and a (possibly private) selector_string method.

Public Instance Methods

when_enabled(timeout = nil) { |self| ... } click to toggle source

Waits until the element is enabled.

@example

browser.button(name: "new_user_button_2").when_enabled.click

@param [Integer] timeout seconds to wait before timing out

@see Watir::Wait @see Watir::Element#enabled?

# File lib/watir/legacy_wait.rb, line 107
def when_enabled(timeout = nil)
  msg = '#when_enabled'
  repl_msg = 'wait_until(&:enabled?)'
  Watir.logger.deprecate msg, repl_msg, ids: [:when_enabled]

  timeout ||= Watir.default_timeout
  message = "waiting for #{selector_string} to become enabled"

  if block_given?
    Wait.until(timeout, message) { enabled? }
    yield self
  else
    WhenEnabledDecorator.new(self, timeout, message)
  end
end
when_present(timeout = nil) { |self| ... } click to toggle source

Waits until the element is present.

@example

browser.text_field(name: "new_user_first_name").when_present.click
browser.text_field(name: "new_user_first_name").when_present { |field| field.set "Watir" }
browser.text_field(name: "new_user_first_name").when_present(60).text

@param [Integer] timeout seconds to wait before timing out

@see Watir::Wait @see Watir::Element#present?

# File lib/watir/legacy_wait.rb, line 79
def when_present(timeout = nil)
  msg = '#when_present'
  repl_msg = '#wait_until_present if a wait is still needed'
  Watir.logger.deprecate msg, repl_msg, ids: [:when_present]

  timeout ||= Watir.default_timeout
  message = "waiting for #{selector_string} to become present"

  if block_given?
    Wait.until(timeout, message) { present? }
    yield self
  else
    WhenPresentDecorator.new(self, timeout, message)
  end
end