mirror of
https://github.com/cypress-io/cypress.git
synced 2026-05-24 01:08:50 -05:00
Jennifer Shehane
146 lines
3.8 KiB
Markdown
146 lines
3.8 KiB
Markdown
---
|
|
title: get
|
|
comments: true
|
|
description: ''
|
|
---
|
|
|
|
Get one or more DOM elements by selector or [alias](https://on.cypress.io/guides/using-aliases).
|
|
|
|
# Syntax
|
|
|
|
```javascript
|
|
.get(selector)
|
|
.get(alias)
|
|
.get(selector, options)
|
|
```
|
|
|
|
## Usage
|
|
|
|
`.get()` cannot be chained off any other cy commands, so should be chained off of `cy` for clarity.
|
|
|
|
**{% fa fa-check-circle green %} Valid Usage**
|
|
|
|
```javascript
|
|
cy.get('.list>li')
|
|
```
|
|
|
|
## Arguments
|
|
|
|
**{% fa fa-angle-right %} selector** ***(String selector)***
|
|
|
|
A selector used to filter matching DOM elements.
|
|
|
|
**{% fa fa-angle-right %} alias** ***(String)***
|
|
|
|
An alias as defined using the [`.as()`](https://on.cypress.io/api/as) command and referenced with the `@` character and the name of the alias.
|
|
|
|
Internally, Cypress keeps a cache of all aliased elements. If the element currently exists in the DOM, it is immediately returned. If the element no longer exists, Cypress will re-query the element based on the previous selector path defined before [`.as()`](https://on.cypress.io/api/as) to find it again.
|
|
|
|
{% note info %}
|
|
[Read about using aliases here.](https://on.cypress.io/guides/using-aliases)
|
|
{% endnote %}
|
|
|
|
**{% fa fa-angle-right %} options** ***(Object)***
|
|
|
|
Pass in an options object to change the default behavior of `.get()`.
|
|
|
|
Option | Default | Notes
|
|
--- | --- | ---
|
|
`log` | `true` | whether to display command in command log
|
|
`timeout` | [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts) | Total time to retry getting the element
|
|
|
|
## Yields
|
|
|
|
`.get()` yields the new DOM element(s) found by the command.
|
|
|
|
## Timeout
|
|
|
|
`.get()` will continue to look for the elements for the duration of the [`defaultCommandTimeout`](https://on.cypress.io/guides/configuration#timeouts)
|
|
|
|
# Examples
|
|
|
|
## Selector
|
|
|
|
**Get the input element**
|
|
|
|
```javascript
|
|
cy.get('input').should('be.disabled')
|
|
```
|
|
|
|
**Find the first `li` descendent within a `ul`**
|
|
|
|
```javascript
|
|
cy.get('ul li:first').should('have.class', 'active')
|
|
```
|
|
|
|
**Find the `.dropdown-menu` and click it.**
|
|
|
|
```javascript
|
|
cy.get('.dropdown-menu').click()
|
|
```
|
|
|
|
## Get Within
|
|
|
|
**`.get()` in a [`.within()`](https://on.cypress.io/api/within)**
|
|
|
|
Since `.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.
|
|
|
|
```javascript
|
|
cy.get('form').within(function(){
|
|
cy.get('input').type('Pamela') // Get the input within form
|
|
cy.get('textarea').type('is a developer') // Find the textarea within form
|
|
})
|
|
```
|
|
|
|
## Alias
|
|
|
|
For a detailed explanation of aliasing, [read more about aliasing here](https://on.cypress.io/guides/using-aliases).
|
|
|
|
**Retrieve aliased `todos` elements**
|
|
|
|
```javascript
|
|
cy.get('ul#todos').as('todos')
|
|
|
|
//...hack hack hack...
|
|
|
|
//later retrieve the todos
|
|
cy.get('@todos')
|
|
```
|
|
|
|
**Get the `submitBtn`**
|
|
|
|
```javascript
|
|
beforeEach(function(){
|
|
cy.get('button[type=submit]').as('submitBtn')
|
|
})
|
|
|
|
it('disables on click', function(){
|
|
cy.get('@submitBtn').should('be.disabled')
|
|
})
|
|
```
|
|
|
|
# Command Log
|
|
|
|
**Get an input and assert on the value**
|
|
|
|
```javascript
|
|
cy
|
|
.get('input[name='firstName']')
|
|
.should('have.value', 'Homer')
|
|
```
|
|
|
|
The commands above will display in the command log as:
|
|
|
|
<img width="524" alt="screen shot 2015-11-27 at 1 24 20 pm" src="https://cloud.githubusercontent.com/assets/1271364/11446808/5d2f2180-950a-11e5-8645-4f0f14321f86.png">
|
|
|
|
When clicking on the `get` command within the command log, the console outputs the following:
|
|
|
|
<img width="543" alt="screen shot 2015-11-27 at 1 24 45 pm" src="https://cloud.githubusercontent.com/assets/1271364/11446809/61a6f4f4-950a-11e5-9b23-a9efa1fbccfc.png">
|
|
|
|
# See also
|
|
|
|
- [as](https://on.cypress.io/api/as)
|
|
- [contains](https://on.cypress.io/api/contains)
|
|
- [find](https://on.cypress.io/api/find)
|
|
- [within](https://on.cypress.io/api/within)
|