get

Improve this doc

Get one or more DOM elements by selector or alias.

The querying behavior of this command matches exactly how $(…) works in jQuery.

Syntax

cy.get(selector)
cy.get(alias)
cy.get(selector, options)
cy.get(alias, options)

Usage

Correct Usage

cy.get('.list > li')    // Yield the <li>'s in .list

Arguments

selector (String selector)

A selector used to filter matching DOM elements.

alias (String)

An alias as defined using the .as() command and referenced with the @ character and the name of the alias.

You can use cy.get() for aliases of primitives, regular objects, or even DOM elements.

When using aliases with DOM elements, Cypress will query the DOM again if the previously aliased DOM element has gone stale.

Core Concept

You can read more about aliasing objects and elements in our Core Concept Guide.

options (Object)

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

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

Yields

  • cy.get() yields the DOM element(s) it found.

Examples

Selector

Get the input element

cy.get('input').should('be.disabled')

Find the first li descendent within a ul

cy.get('ul li:first').should('have.class', 'active')

Find the the dropdown-menu and click it.

cy.get('.dropdown-menu').click()

Get in Within

cy.get() in the .within() command

Since cy.get() is chained off of cy, it always looks for the selector within the entire document. The only exception is when used inside a .within() command.

cy.get('form').within(() => {
  cy.get('input').type('Pamela')            // Only yield inputs within form
  cy.get('textarea').type('is a developer') // Only yield textareas within form
})

Alias

For a detailed explanation of aliasing, read more about aliasing here.

Get the aliased ‘todos’ elements

cy.get('ul#todos').as('todos')

//...hack hack hack...

//later retrieve the todos
cy.get('@todos')

Get the aliased ‘submitBtn’ element

beforeEach(function () {
  cy.get('button[type=submit]').as('submitBtn')
})

it('disables on click', function () {
  cy.get('@submitBtn').should('be.disabled')
})

Get the aliased ‘users’ fixture

beforeEach(function () {
  cy.fixtures('users.json').as('users')
})

it('disables on click', function () {
  // access the array of users
  cy.get('@users').then((users) => {
    // get the first user
    const user = users[0]

    cy.get('header').contains(user.name)
  })
})

Rules

Requirements

  • cy.get() requires being chained off of cy.

Assertions

  • cy.get() will automatically retry itself until the element(s) exist in the DOM.

  • cy.get() will automatically retry itself until assertions you've chained all pass.

Timeouts

  • cy.get() can time out waiting for the element(s) to exist in the DOM.

  • cy.get() can time out waiting for assertions you've added to pass.

Command Log

Get an input and assert on the value

cy.get('input[name="firstName"]').should('have.value', 'Homer')

The commands above will display in the command log as:

Command Log get

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

Console Log get

See also