The parent WebDriver instance for this element.
A promise that will resolve to the promised element.
Readonly [toAttaches a callback for only the rejection of the Promise.
Optional onrejected: null | ((reason) => TResult | PromiseLike<TResult>)The callback to execute when the Promise is rejected.
A Promise for the completion of the callback.
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
Optional onfinally: null | (() => void)The callback to execute when the Promise is settled (fulfilled or rejected).
A Promise for the completion of the callback.
Schedule a command to find a descendant of this element. If the element cannot be found, a bot.ErrorCode.NO_SUCH_ELEMENT result will be returned by the driver. Unlike other commands, this error cannot be suppressed. In other words, scheduling a command to find an element doubles as an assert that the element is present on the page. To test whether an element is present on the page, use #findElements.
The search criteria for an element may be defined using one of the factories in the By namespace, or as a short-hand By.Hash 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 WebDriver instance and returns a WebElement, or a promise that will resolve to a WebElement. 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 links.isDisplayed();
}).then(function(visibleLinks) {
return visibleLinks[0];
});
}
The locator strategy to use when searching for the element.
A WebElement that can be used to issue commands against the located element. If the element is not found, the element will be invalidated and all scheduled commands aborted.
Schedules a command to find all of the descendants of this element that match the given search criteria.
The locator strategy to use when searching for the element.
A promise that will resolve to an array of WebElements.
Schedules a command to query for the value of the given attribute of the 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 semi-colon. 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:
The name of the attribute to query.
A promise that will be resolved with the attribute's value. The returned value will always be either a string or null.
Schedules a command to query for the computed style of the element represented by 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.
The name of the CSS style property to look up.
A promise that will be resolved with the requested CSS value.
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.
A promise that will be resolved with the elements shadow root or rejected with NoSuchShadowRootError
Schedules a command to type a sequence on the DOM element represented by this promsieinstance.
Modifier keys (SHIFT, CONTROL, ALT, META) are stateful; once a modifier is processed in the keysequence, 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 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 keysequence 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 analgous 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 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 punctionation keys will be synthesized according to a standard QWERTY en-us keyboard layout.
Rest ...var_args: (string | number | Promise<string | number>)[]The sequence of keys to type. All arguments will be joined into a single sequence.
A promise that will be resolved when all keys have been typed.
Take a screenshot of the visible region encompassed by this element's bounding rectangle.
Optional opt_scroll: booleanOptional argument that indicates whether the element should be scrolled into view before taking a screenshot. Defaults to false.
A promise that will be resolved to the screenshot as a base-64 encoded PNG.
Attaches callbacks for the resolution and/or rejection of the Promise.
Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)The callback to execute when the Promise is resolved.
Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)The callback to execute when the Promise is rejected.
A Promise for the completion of which ever callback is executed.
Static buildThe raw ID.
Optional opt_noLegacy: booleanWhether to exclude the legacy element key.
The element ID for use with WebDriver's wire protocol.
Static equalsCompares two WebElements for equality.
A WebElement.
A WebElement.
A promise that will be resolved to whether the two WebElements are equal.
Static extractExtracts the encoded WebElement ID from the object.
The object to extract the ID from.
the extracted ID.
if the object is not a valid encoded ID.
Static isthe object to test.
whether the object is a valid encoded WebElement ID.
Generated using TypeDoc
Implement WebElementPromise