WebElement

Clear the value of this element. This command has no effect if the underlying DOM element is neither a text INPUT element nor a TEXTAREA element.

Clicks on this element.

Schedule a command to find a descendant of this element. If the element cannot be found, the returned promise will be rejected with a NoSuchElementError.

The search criteria for an element may be defined using one of the static factories on the by.By class, or as a short-hand ./by.ByHash object. For example, the following two statements are equivalent:

var e1 = element.findElement(By.id('foo'));
var e2 = element.findElement({id:'foo'});

You may also provide a custom locator function, which takes as input this instance and returns a WebElement, or a promise that will resolve to a WebElement. If the returned promise resolves to an array of WebElements, WebDriver will use the first element. For example, to find the first visible link on a page, you could write:

var link = element.findElement(firstVisibleLink);

function firstVisibleLink(element) {
  var links = element.findElements(By.tagName('a'));
  return promise.filter(links, function(link) {
    return link.isDisplayed();
  });
}

Locates all the descendants of this element that match the given search criteria.

Get the computed WAI-ARIA label of element.

Get the computed WAI-ARIA role of element.

Retrieves the current value of the given attribute of this element. Will return the current value, even if it has been modified after the page has been loaded. More exactly, this method will return the value of the given attribute, unless that attribute is not present, in which case the value of the property with the same name is returned. If neither value is set, null is returned (for example, the "value" property of a textarea element). The "style" attribute is converted as best can be to a text representation with a trailing semicolon. The following are deemed to be "boolean" attributes and will return either "true" or null:

async, autofocus, autoplay, checked, compact, complete, controls, declare, defaultchecked, defaultselected, defer, disabled, draggable, ended, formnovalidate, hidden, indeterminate, iscontenteditable, ismap, itemscope, loop, multiple, muted, nohref, noresize, noshade, novalidate, nowrap, open, paused, pubdate, readonly, required, reversed, scoped, seamless, seeking, selected, spellcheck, truespeed, willvalidate

Finally, the following commonly mis-capitalized attribute/property names are evaluated as expected:

• "class"
• "readonly"

Retrieves the value of a computed style property for this instance. If the element inherits the named style from its parent, the parent will be queried for its value. Where possible, color values will be converted to their hex representation (e.g. #00ff00 instead of rgb(0, 255, 0)).

Warning: the value returned will be as the browser interprets it, so it may be tricky to form a proper assertion.

Get the value of the given attribute of the element.

This method, unlike #getAttribute(String), returns the value of the attribute with the given name but not the property with the same name.

The following are deemed to be "boolean" attributes, and will return either "true" or null:

async, autofocus, autoplay, checked, compact, complete, controls, declare, defaultchecked, defaultselected, defer, disabled, draggable, ended, formnovalidate, hidden, indeterminate, iscontenteditable, ismap, itemscope, loop, multiple, muted, nohref, noresize, noshade, novalidate, nowrap, open, paused, pubdate, readonly, required, reversed, scoped, seamless, seeking, selected, truespeed, willvalidate

See W3C WebDriver specification for more details.

Get the given property of the referenced web element

Returns an object describing an element's location, in pixels relative to the document element, and the element's size in pixels.

Get the shadow root of the current web element.

Retrieves the element's tag name.

Get the visible (i.e. not hidden by CSS) innerText of this element, including sub-elements, without any leading or trailing whitespace.

Test whether this element is currently displayed.

Tests whether this element is enabled, as dictated by the disabled attribute.

Tests whether this element is selected.

Types a key sequence on the DOM element represented by this instance.

Modifier keys (SHIFT, CONTROL, ALT, META) are stateful; once a modifier is processed in the key sequence, that key state is toggled until one of the following occurs:

• The modifier key is encountered again in the sequence. At this point the state of the key is toggled (along with the appropriate keyup/down events).

• The input.Key.NULL key is encountered in the sequence. When this key is encountered, all modifier keys current in the down state are released (with accompanying keyup events). The NULL key can be used to simulate common keyboard shortcuts:

    element.sendKeys("text was",
                     Key.CONTROL, "a", Key.NULL,
                     "now text is");
    // Alternatively:
    element.sendKeys("text was",
                     Key.chord(Key.CONTROL, "a"),
                     "now text is");
  

• The end of the key sequence is encountered. When there are no more keys to type, all depressed modifier keys are released (with accompanying keyup events).

If this element is a file input ({@code }), the specified key sequence should specify the path to the file to attach to the element. This is analogous to the user clicking "Browse..." and entering the path into the file select dialog.

var form = driver.findElement(By.css('form'));
var element = form.findElement(By.css('input[type=file]'));
element.sendKeys('/path/to/file.txt');
form.submit();

For uploads to function correctly, the entered path must reference a file on the browser's machine, not the local machine running this script. When running against a remote Selenium server, a input.FileDetector may be used to transparently copy files to the remote machine before attempting to upload them in the browser.

Note: On browsers where native keyboard events are not supported (e.g. Firefox on OS X), key events will be synthesized. Special punctuation keys will be synthesized according to a standard QWERTY en-us keyboard layout.

Submits the form containing this element (or this element if it is itself a FORM element). his command is a no-op if the element is not contained in a form.

Take a screenshot of the visible region encompassed by this element's bounding rectangle.

Compares two WebElements for equality.

Extracts the encoded WebElement ID from the object.