.waitForElementVisible() Suggest edits

Waits a given time in milliseconds (default 5000ms) for an element to be visible in the page before performing any other commands or assertions.

If the element fails to be present and visible in the specified amount of time, the test will be marked as failed, and ordinarily, the subsequent steps/commands within the test-case/section will not be performed. However, you have the option to prevent the remaining steps/commands from being skipped by setting abortOnFailure to false.

You can change the polling interval by defining a waitForConditionPollInterval property (in milliseconds) in as a global property in your nightwatch.json or in your external globals file.

Similarly, a default timeout can be specified as a global waitForConditionTimeout property (in milliseconds).

For more info on working with DOM elements in Nightwatch, refer to the Finding & interacting with DOM Elements guide page.

Usage

                    .waitForElementVisible([using], selector, [timeout], [pollInterval], [abortOnAssertionFailure], [callback], [message]);

Example

module.exports = {
 'demo Test': function(browser) {
    // with default implicit timeout of 5000ms (can be overwritten in settings under 'globals.waitForConditionTimeout')
    browser.waitForElementVisible('#index-container');

    // specify the locate strategy (css selector/xpath) as the first argument
    browser.waitForElementVisible('css selector', '#index-container');

    // with explicit timeout (in milliseconds)
    browser.waitForElementVisible('#index-container', 1000);

    // continue if failed
    browser.waitForElementVisible('#index-container', 1000, false);

    // with callback
    browser.waitForElementVisible('#index-container', 1000, function() {
      // do something while we're here
    });

    // with custom output message - the locate strategy is required
    browser.waitForElementVisible('css selector', '#index-container', 'The index container is found.');

    // with custom Spanish message
    browser.waitForElementVisible('#index-container', 1000, 'elemento %s no era presente en %d ms');

    // many combinations possible - the message is always the last argument
    browser.waitForElementVisible('#index-container', 1000, false, function() {}, 'elemento %s no era visible en %d ms');
  },

  'demo Test with selector objects': function(browser) {
     browser.waitForElementVisible({
       selector: '#index-container',
       timeout: 1000
     });

     browser.waitForElementVisible({
       selector: '#index-container',
       locateStrategy: 'css selector'
     }, 'Custom output message');

     browser.waitForElementVisible({
       selector: '.container',
       index: 2,
       retryInterval: 100,
       abortOnFailure: true
     });
  }

  'page object demo Test': function (browser) {
     var nightwatch = browser.page.nightwatch();
     nightwatch
       .navigate()
       .assert.titleContains('Nightwatch.js');

     nightwatch.waitForElementVisible('@featuresList', function(result) {
       console.log(result);
     });
  }
}

Parameters

Name Type description
using
Optional		 string

The locator strategy to use. See W3C Webdriver - locator strategies
selector string | object

The selector (CSS/Xpath) used to locate the element. Can either be a string or an object which specifies element properties.
time=waitForConditionTimeout
Optional		 number

The total number of milliseconds to wait before failing.
poll=waitForConditionPollInterval
Optional		 number

The number of milliseconds to wait between checks. You can use this only if you also specify the time parameter.
abortOnFailure=abortOnAssertionFailure
Optional		 boolean

By the default if the element is not found the test will fail. Set this to false if you wish for the test to continue even if the assertion fails. To set this globally you can define a property abortOnAssertionFailure in your globals.
callback
Optional		 function

Optional callback function to be called when the command finishes.
message
Optional		 string

Optional message to be shown in the output; the message supports two placeholders: %s for current selector and %d for the time (e.g. Element %s was not in the page for %d ms).