Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing isSelected command to new Element API. #4038

Merged
37 changes: 37 additions & 0 deletions lib/api/web-element/commands/isSelected.js
@@ -0,0 +1,37 @@
/**
* Determines if an element is selected.
*
* For more info on working with DOM elements in Nightwatch, refer to the <a href="https://nightwatchjs.org/guide/writing-tests/finding-interacting-with-dom-elements.html">Finding & interacting with DOM Elements</a> guide page.
*
* @example
* describe('isSelected Demo', function() {
*
* it('test isSelected', function(browser) {
* browser
* .element('#search')
* .isSelected(function callback(result) {
* assert.equal(result.value, true);
* });
dikwickley marked this conversation as resolved.
Show resolved Hide resolved
* });
*
* it('test async isSelected', async function(browser) {
* const result = await browser
* .element('#search')
* .isSelected();
* assert.equal(result, true)
* });
dikwickley marked this conversation as resolved.
Show resolved Hide resolved
*
* after(browser => browser.end());
* });
*
* @since 3.0.0
dikwickley marked this conversation as resolved.
Show resolved Hide resolved
* @method isSelected
* @memberof ScopedWebElement
* @instance
* @syntax browser.element(selector).isSelected()
* @see https://www.w3.org/TR/webdriver/#is-element-selected
* @returns {ScopedValue<boolean>}
*/
module.exports.command = function () {
return this.runQueuedCommandScoped('isElementSelected');
};
46 changes: 46 additions & 0 deletions test/src/api/commands/web-element/testIsSelected.js
@@ -0,0 +1,46 @@
const assert = require('assert');
const MockServer = require('../../../../lib/mockserver.js');
const CommandGlobals = require('../../../../lib/globals/commands.js');

describe('element().isSelected() command', function() {
before(function (done) {
CommandGlobals.beforeEach.call(this, done);
});

after(function(done) {
CommandGlobals.afterEach.call(this, done);
});

it('test .element().isSelected()', function() {
MockServer.addMock({
url: '/wd/hub/session/1352110219202/element/0/selected',
method: 'GET',
response: JSON.stringify({
sessionId: '1352110219202',
status: 0,
value: true
})
});

this.client.api.element('#weblogin').isSelected(function (result) {
this.assert.equal(result.value, true);
});
});

it('async test .element().isSelected()', async function() {
MockServer.addMock({
url: '/wd/hub/session/1352110219202/element/0/selected',
method: 'GET',
response: JSON.stringify({
sessionId: '1352110219202',
status: 0,
value: true
})
});

const resultPromise = this.client.api.element('#weblogin').isSelected();
const result = await resultPromise;
assert.equal(result, true);
});
});

1 change: 1 addition & 0 deletions types/tests/webElement.test-d.ts
Expand Up @@ -163,6 +163,7 @@ describe('new element() api', function () {
expectType<Promise<WebElement>>(elem.doubleClick());
expectType<Promise<WebElement>>(elem.rightClick());
expectType<Promise<WebElement>>(elem.waitUntil('visible', {timeout: 5000}));
expectType<Promise<boolean>>(elem.isSelected());
});

test('test element assertions', async function () {
Expand Down
2 changes: 2 additions & 0 deletions types/web-element.d.ts
Expand Up @@ -187,6 +187,8 @@ export interface ScopedElement extends Element, PromiseLike<WebElement> {

rightClick(): Promise<WebElement>;

isSelected(): ElementValue<boolean>;

waitUntil(signalOrOptions: WaitUntilActions | WaitUntilOptions, waitOptions?: WaitUntilOptions): Promise<WebElement>;
}

Expand Down