cbec33d637
- Updated some existing api docs to reflect structure changes - Added missing ‘pause’ command to sidebar and .yml english.
2.4 KiB
title, comments, description
| title | comments | description |
|---|---|---|
| parent | true |
Get the parent DOM element of a set of DOM elements.
Syntax
.parent()
.parent(selector)
.parent(options)
.parent(selector, options)
Usage
.parent() requires being chained off another cy command that yields a DOM element or set of DOM elements.
{% fa fa-check-circle green %} Valid Usage
cy.get('header').parent() // Yield parent el of `header`
{% fa fa-exclamation-triangle red %} Invalid Usage
cy.parent() // Errors, cannot be chained off 'cy'
cy.reload().parent() // Errors, 'reload' does not yield DOM element
Arguments
{% fa fa-angle-right %} selector (String selector)
A selector used to filter matching DOM elements.
{% fa fa-angle-right %} options (Object)
Pass in an options object to change the default behavior of .parent().
| Option | Default | Notes |
|---|---|---|
log |
true |
whether to display command in command log |
timeout |
defaultCommandTimeout |
Total time to retry getting the element |
Yields
.parent() yields the new DOM element(s) found by the command.
Timeout
.parent() will continue to look for the parent element(s) for the duration of the defaultCommandTimeout
Examples
Parent
Get the parent of the active li
cy.get('li.active').parent()
Selector
Get the parent with class nav of the active li
cy.get('li.active').parent('.nav')
Command Log
Assert on the parent of the active li
cy.get('li.active').parent().should('have.class', 'nav')
The commands above will display in the command log as:
When clicking on the parent command within the command log, the console outputs the following:
