click

Click on an element.

This issues a WebDriver click command for the selected element , which generally scrolls to and then clicks the selected element when no options are passed. When options object is passed it uses action class instead of webdriver click which give added capabilities like passing button type, coordinates etc. By default, when using options a release action command is send after performing the click action, pass option.skipRelease=true to skip this action. Before the actions, when the pointer would not hit the element at its center (it is outside the window, hidden by a scroll container or covered by a fixed header or footer), the element is scrolled to the center of the window and of its scroll containers (to the bottom or the top when something covers it at the center), and the page gets its scroll events before the click. An element that the pointer already hits is not scrolled. In Firefox, and in Safari and web views on iOS with Appium, a click without options does the same before the WebDriver click command, because geckodriver and Appium scroll and click without giving the page its scroll events first. With an Appium XCUITest driver older than 12.18.2, a click on iOS that scrolls waits 100 ms more. When something intercepts a click without options in any browser (for example a sticky header), the element is brought under the pointer in the same way and clicked again.

info

If you have fixed-position elements (such as a fixed header or footer) that cover up the selected element after it is scrolled within the viewport, the click will be issued at the given coordinates, but will be received by your fixed (overlaying) element. In these cased the following error is thrown:

Element is not clickable at point (x, x). Other element would receive the click: ..."

To work around this, try to find the overlaying element and remove it via execute command so it doesn't interfere the click. You also can try to scroll to the element yourself using scroll with an offset appropriate for your scenario.

info

The click command can also be used to simulate a long press on a mobile device. This is done by setting the duration. See the example below for more information.

Usage

await $(selector).click({ button, x, y, skipRelease, duration })

Parameters

Name	Type	Details
options optional	ClickOptions	Click options (optional)
options.button optional	string, number	Can be one of [0, "left", 1, "middle", 2, "right"] WEB-ONLY (Desktop/Mobile)
options.x optional	number	Clicks X horizontal pixels away from location of the element (from center point of element) WEB and Native (Desktop/Mobile)
options.y optional	number	Clicks Y vertical pixels away from location of the element (from center point of element) WEB and Native support (Desktop/Mobile)
options.skipRelease optional	boolean	Boolean (optional) WEB-ONLY (Desktop/Mobile)
options.duration optional	number	Duration of the click, aka "LongPress" MOBILE-NATIVE-APP-ONLY (Mobile)

Examples

example.html

<button id="myButton" onclick="document.getElementById('someText').innerHTML='I was clicked'">Click me</button>
<div id="someText">I was not clicked</div>

click.js

it('should demonstrate the click command', async () => {
    const myButton = await $('#myButton')
    await myButton.click()
    const myText = await $('#someText')
    const text = await myText.getText()
    assert(text === 'I was clicked') // true
})

example.js

it('should fetch menu links and visit each page', async () => {
    const links = await $$('#menu a')
    await links.forEach(async (link) => {
        await link.click()
    })
})

example.html

<button id="myButton">Click me</button>

example.js

it('should demonstrate a click using an offset', async () => {
    const myButton = await $('#myButton')
    await myButton.click({ x: 30 }) // clicks 30 horizontal pixels away from location of the button (from center point of element)
})

example.html

<button id="myButton">Click me</button>

example.js

it('should demonstrate a right click passed as string', async () => {
    const myButton = await $('#myButton')
    await myButton.click({ button: 'right' }) // opens the contextmenu at the location of the button
})
it('should demonstrate a right click passed as number while adding an offset', async () => {
    const myButton = await $('#myButton')
    await myButton.click({ button: 2, x: 30, y: 40 }) // opens the contextmenu 30 horizontal and 40 vertical pixels away from location of the button (from the center of element)
})
it('should skip sending releaseAction command that cause unexpected alert closure', async () => {
    const myButton = await $('#myButton')
    await myButton.click({ button: 2, x: 30, y: 40, skipRelease:true }) // skips sending releaseActions
})

longpress.example.js

it('should be able to open the contacts menu on iOS by executing a longPress', async () => {
    const contacts = await $('~Contacts')
    // opens the Contacts menu on iOS where you can quickly create
    // a new contact, edit your home screen, or remove the app
    await contacts.click({ duration: 2000 })
})