Skip to main content
Version: v8

isClickable

Overview​

Use the isClickable command to determine whether a given DOM element is clickable.

The command returns true if the selected DOM element:

  • exists
  • is visible
  • is within the viewport (if not, try scrolling to the element)
  • has its center unobstructed by another element
  • is not disabled

Otherwise, the command returns false.

warning

The isClickable command works only in a web browser and in the webview context of mobile applications.

The command does not work in the native context of mobile applications.

Additionally, unlike other element commands, Testplane will not wait for the element to exist before executing this command.

Usage​

await browser.$(selector).isClickable();

Usage Examples​

it("should detect if an element is clickable", async ({ browser }) => {
    const el = await browser.$("#el");
    let clickable = await el.isClickable();
    console.log(clickable); // outputs: true or false

    // wait until the element is clickable
    await browser.waitUntil(() => el.isClickable());
});

References​

We'd like to give credit to the original WebdriverIO docs article, from which we drew some information while writing our version.

On this page