Clear a textarea or a text input element's value.

The command clearValue() will automatically wait for the element to be present (until the specified timeout). If the element is not found, an error is thrown which will cause the test to fail. You can suppress element not found errors by specifying the selector argument as an object and passing the suppressNotFoundErrors = true option.

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

Usage

                    browser.clearValue('<SELECTOR>', function (result) { }])
                
                    // using global element()
browser.clearValue(element('<SELECTOR>'))
                

Example

module.exports = {
  demoTest(browser) {
    browser.clearValue('#login input[type=text]');

    browser.clearValue('#login input[type=text]', function(result) {
      console.log('clearValue result', result);
    });

    // with explicit locate strategy
    browser.clearValue('css selector', '#login input[type=text]');

    // with selector object - see https://nightwatchjs.org/guide#element-properties
    browser.clearValue({
      selector: '#login input[type=text]',
      index: 1,
      suppressNotFoundErrors: true
    });

    browser.clearValue({
      selector: '#login input[type=text]',
      timeout: 2000 // overwrite the default timeout (in ms) to check if the element is present
    });
  }
}

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.

callback
Optional
function

Optional callback function to be called when the command finishes.

W3C WebDriver spec