Click a DOM element.
Syntax
.click() .click(options) .click(position) .click(position, options) .click(x, y) .click(x, y, options)
Usage
Correct Usage
cy.get('button').click() // Click on button
cy.focused().click() // Click on el with focus
cy.contains('Welcome').click() // Click on first el containing 'Welcome'
Incorrect Usage
cy.click('button') // Errors, cannot be chained off 'cy'
cy.window().click() // Errors, 'window' does not yield DOM element
Arguments
position (String)
The position where the click should be issued. The center position is the default position. Valid positions are topLeft, top, topRight, left, center, right, bottomLeft, bottom, and bottomRight.
x (Number)
The distance in pixels from the element’s left to issue the click.
y (Number)
The distance in pixels from the element’s top to issue the click.
options (Object)
Pass in an options object to change the default behavior of .click().
| Option | Default | Description |
|---|---|---|
log | true | Displays the command in the Command log |
force | false | Forces the action, disables waiting for actionability |
multiple | false | Serially click multiple elements |
timeout | defaultCommandTimeout | Time to wait for .click() to resolve before timing out
|
Yields
.click()yields the same subject it was given from the previous command.
Examples
No Args
Click the button
cy.get('button').click()
Position
Specify a corner of the element to click
Click the top right corner of the button.
cy.get('button').click('topRight')
Coordinates
Specify explicit coordinates relative to the top left corner
The click below will be issued inside of the element (15px from the left and 40px from the top).
cy.get('button').click(15, 40)
Options
Force a click regardless of its actionable state
Forcing a click overrides the actionable checks Cypress applies and will automatically fire the events.
cy.get('button').click({ force: true })
Force a click with position argument
cy.get('button').click('bottomLeft', { force: true })
Force a click with relative coordinates
cy.get('button').click(5, 60, { force: true })
Click all buttons found on the page
By default, Cypress will error if you’re trying to click multiple elements. By passing { multiple: true } Cypress will iteratively apply the click to each element and will also log to the Command Log multiple times.
cy.get('button').click({ multiple: true })
Click with key combinations
The .click() command may also be fired with key modifiers in combination with the .type() command in order to simulate character sequences while clicking, such as ALT + click. In order to keep the modifier key active, {release: false} should be passed to the options of the .type() command.
The following modifiers can be combined with .click().
| Sequence | Notes |
|---|---|
{alt} | Activates the altKey modifier. Aliases: {option}
|
{ctrl} | Activates the ctrlKey modifier. Aliases: {control}
|
{meta} | Activates the metaKey modifier. Aliases: {command}, {cmd}
|
{shift} | Activates the shiftKey modifier. |
Shift click
// execute a SHIFT + click on the first <li>
// {release: false} is necessary so that
// SHIFT will not be released after the type command
cy.get('body').type('{shift}', { release: false })
.get('li:first').click()
Notes
Actionability
The element must first reach actionability
.click() is an “action command” that follows all the rules defined here.
Events
Events that are fired:
cy.get('button').click()
// mousedown
// focus
// mouseup
// click
The events are fired to spec, including the coordinates of where the event took place.
At the moment, mouseover and mouseout events are not fired. Open an issue if you need this to be fixed.
Additionally if the mousedown event causes the element to be removed from the DOM, the remaining events should continue to be fired, but to the resulting element left below the removed element. This has also not been implemented. Open an issue if you need this to be fixed.
Focus
Focus is given to the first focusable element
For example, clicking a <span> inside of a <button> gives the focus to the button, since that’s what would happen in a real user scenario.
However, Cypress additionally handles situations where a child descendent is clicked inside of a focusable parent, but actually isn’t visually inside the parent (per the CSS Object Model). In those cases if no focusable parent is found the window is given focus instead (which matches real browser behavior).
Cancellation
Mousedown cancellation will not cause focus
If the mousedown event has its default action prevented (e.preventDefault()) then the element will not receive focus as per the spec.
Element removal during mousedown or mouseup
The spec states what should happen if the element clicked is removed from the DOM during mousedown or mouseup, but Cypress is not currently factoring this in. Open an issue if you need this to be fixed.
pointer-events: none
Cypress does not currently factor in pointer-events: none in its clicking algorithm. Open an issue if you need this to be fixed.
Rules
Requirements
.click()requires being chained off a command that yields DOM element(s).
Assertions
.click()will automatically wait for the element to reach an actionable state..click()will automatically wait for assertions you've chained to pass.
Timeouts
.click()can time out waiting for the element to reach an actionable state..click()can time out waiting for assertions you've added to pass.
Command Log
Click the button in the form that has text “Create User”
cy.get('form').find('button').contains('Create User').click()
The commands above will display in the Command Log as:
When clicking on click within the command log, the console outputs the following:
