click()

Click an element you’ve located with find():

const signInButton = await testdriver.find('Sign in button');
await signInButton.click();

Or chain it straight onto find():

await testdriver.find('Sign in button').click();

element.click(action)

Clicks the element at the point where find() located it.

element.click(action?: ClickAction): Promise<void>

Parameters

ClickAction

default:"click"

The mouse action to perform:

'click': a left click
'double-click': a double click, same as doubleClick()
'right-click': a right click, same as rightClick()
'hover': move the mouse there without clicking, same as hover()
'mouseDown' and 'mouseUp': press or release the button, for dragging. See mouseDown().

Errors

Throws an ElementNotFoundError if find() didn’t locate the element. Check found() first when the element might not be there:

const banner = await testdriver.find('cookie consent banner', { timeout: 0 });
if (banner.found()) {
  await testdriver.find('Accept all cookies button').click();
}

testdriver.click(options)

Clicks a point on the screen by its coordinates. Prefer element.click(), which keeps working when the layout or screen size changes.

testdriver.click(options: { x: number; y: number; action?: ClickAction }): Promise<void>

Parameters

object

required

Show properties

number

required

Distance from the left edge of the screen, in pixels.

number

required

Distance from the top edge of the screen, in pixels.

ClickAction

default:"click"

The mouse action, as for element.click(). 'hover' doesn’t move the mouse here; use testdriver.hover({ x, y }) instead.

await testdriver.click({ x: 640, y: 360 });
await testdriver.click({ x: 640, y: 360, action: 'right-click' });

The older form testdriver.click(x, y, action) still works. Use the options object in new tests.

Examples

await testdriver.find('report.pdf in the file list').click('right-click');
await testdriver.find('Rename in the context menu').click();

Open a file

await testdriver.find('report.pdf in the file list').click('double-click');

Drag an item

await testdriver.find('Task card titled "Write docs"').mouseDown();
await testdriver.find('Done column').hover();
await testdriver.find('Done column').mouseUp();

Complete example

tests/login.test.mjs

import { describe, expect, it } from 'vitest';
import { TestDriver } from 'testdriverai/vitest/hooks';

describe('Login', () => {
  it('shows an error for an empty form', async (context) => {
    const testdriver = TestDriver(context);
    await testdriver.provision.chrome({ url: 'https://testdriver-sandbox.vercel.app/login' });

    await testdriver.find('Sign in button below the password field').click();

    const result = await testdriver.assert('an error says the fields are required');
    expect(result).toBe(true);
  });
});

find(): locate the element to click
doubleClick(), rightClick(), and hover(): shortcuts for the other actions
mouseDown() and mouseUp(): drag and drop
Perform actions: every kind of action in one guide

Overview

Using TestDriver

Building & maintaining tests

Advanced topics

element.click(action)

Parameters

Errors

testdriver.click(options)

Parameters

Examples

Open a context menu

Open a file

Drag an item

Complete example

​element.click(action)

​Parameters

​Errors

​testdriver.click(options)

​Parameters

​Examples

​Open a context menu

​Open a file

​Drag an item

​Complete example

​Related

element.click(action)

Parameters

Errors

testdriver.click(options)

Parameters

Examples

Open a context menu

Open a file

Drag an item

Complete example

Related