cypress/docs/source/api/commands/first.md

title, comments, description

title	comments	description
first	true

Get the first DOM element within a set of DOM elements.

Syntax

.first()
.first(options)

Usage

.first() requires being chained off another cy command that yields a DOM element.

{% fa fa-check-circle green %} Valid Usage

cy.get('nav a').first()       // Yield first link in nav
cy.contains('Hello').first()  // Yield first el containing Hello

{% fa fa-exclamation-triangle red %} Invalid Usage

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

Arguments

{% fa fa-angle-right %} options (Object)

Pass in an options object to change the default behavior of cy.first.

Option	Default	Notes
log	true	whether to display command in command log
timeout	defaultCommandTimeout	Total time to retry getting the element

Yields

.first() yields the new DOM element(s) found by the command.

Timeout

.first() will continue to look for the first element for the duration of the defaultCommandTimeout

Examples

First element

Get the first list item in a list.

<ul>
  <li class="one">Knick knack on my thumb</li>
  <li class="two">Knick knack on my shoe</li>
  <li class="three">Knick knack on my knee</li>
  <li class="four">Knick knack on my door</li>
</ul>

// yields <li class="one">Knick knack on my thumb</li>
cy.get('ul').first()

Command Log

Find the first input in the form

cy.get('form').find('input').first()

The commands above will display in the command log as:

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

See also

• last