prev

Get the immediately preceding sibling of each element in a set of the elements.

Syntax

.prev()
.prev(selector)
.prev(options)
.prev(selector, options)

Usage

Correct Usage

cy.get('tr.highlight').prev() // Yield previous 'tr'

Incorrect Usage

cy.prev() // Errors, cannot be chained off 'cy'
cy.getCookies().prev() // Errors, 'getCookies' does not yield DOM element

Arguments

selector (String selector)

A selector used to filter matching DOM elements.

options (Object)

Pass in an options object to change the default behavior of .prev().

Option Default Description
log true Displays the command in the Command log
timeout defaultCommandTimeout Time to wait for .prev() to resolve before timing out

Yields

  • .prev() yields the new DOM element(s) it found.

Examples

No Args

Find the previous element of the element with class of active

<ul>
  <li>Cockatiels</li>
  <li>Lorikeets</li>
  <li class="active">Cockatoos</li>
  <li>Conures</li>
  <li>Eclectus</li>
</ul>
// yields <li>Lorikeets</li>
cy.get('.active').prev()

Selector

Find the previous element with a class of active

<ul>
  <li>Cockatiels</li>
  <li>Lorikeets</li>
  <li class="active">Cockatoos</li>
  <li>Conures</li>
  <li>Eclectus</li>
</ul>
// yields <li>Cockatoos</li>
cy.get('li').prev('.active')

Rules

Requirements

  • .prev() requires being chained off a command that yields DOM element(s).

Assertions

  • .prev() will automatically retry until the element(s) exist in the DOM
  • .prev() will automatically retry until all chained assertions have passed

Timeouts

  • .prev() can time out waiting for the element(s) to exist in the DOM .
  • .prev() can time out waiting for assertions you've added to pass.

Command Log

Find the previous element of the active li

cy.get('.left-nav').find('li.active').prev()

The commands above will display in the Command Log as:

Command Log prev

When clicking on prev within the command log, the console outputs the following:

Console Log prev

See also

© 2017 Cypress.io
Licensed under the MIT License.
https://docs.cypress.io/api/commands/prev