Files
cypress/docs/source/api/commands/parent.md
T

2.1 KiB

title, comments
title comments
parent false

Get the parent DOM element of a set of DOM elements.

Syntax

.parent()
.parent(selector)
.parent(options)
.parent(selector, options)

Usage

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

cy.get('header').parent() // Yield parent el of `header`

{% fa fa-exclamation-triangle red %} Incorrect 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 Description
log true {% usage_options log %}
timeout {% url defaultCommandTimeout configuration#Timeouts %} {% usage_options timeout .parent %}

Yields {% helper_icon yields %}

{% yields changes_dom_subject .parent %}

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')

Rules

Requirements {% helper_icon requirements %}

{% requirements dom .parent %}

Assertions {% helper_icon assertions %}

{% assertions existence .parent %}

Timeouts {% helper_icon timeout %}

{% timeouts existence .parent %}

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:

Command Log parent

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

Console Log parent

See also

  • {% url .children() children %}
  • {% url .parents() parents %}
  • {% url .parentsUntil() parentsuntil %}