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

title, comments

title	comments
parentsUntil	false

Get all ancestors of each DOM element in a set of matched DOM elements up to, but not including, the element provided.

{% note info %} The querying behavior of this command matches exactly how {% url .parentsUntil() http://api.jquery.com/parentsUntil %} works in jQuery. {% endnote %}

Syntax

.parentsUntil(selector)
.parentsUntil(selector, filter)
.parentsUntil(selector, filter, options)
.parentsUntil(element)
.parentsUntil(element, filter)
.parentsUntil(element, filter, options)

Usage

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

cy.get('p').parentsUntil('.article') // Yield parents of 'p' until '.article'

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

cy.parentsUntil()                  // Errors, cannot be chained off 'cy'
cy.location().parentsUntil('href') // Errors, 'location' does not yield DOM element

Arguments

{% fa fa-angle-right %} selector (String selector)

The selector where you want finding parent ancestors to stop.

{% fa fa-angle-right %} element (DOM node, jQuery Object)

The element where you want finding parent ancestors to stop.

{% fa fa-angle-right %} filter (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 .parentsUntil().

Option	Default	Description
log	true	{% usage_options log %}
timeout	{% url defaultCommandTimeout configuration#Timeouts %}	{% usage_options timeout .parentsUntil %}

Yields {% helper_icon yields %}

{% yields changes_dom_subject .parentsUntil %}

Examples

Selector

Find all of the .active element's ancestors until .nav

<ul class="nav">
  <li>
    <a href="#">Clothes</a>
    <ul class="menu">
      <li>
        <a href="/shirts">Shirts</a>
      </li>
      <li class="active">
        <a href="/pants">Pants</a>
      </li>
    </ul>
  </li>
</ul>

// yields [ul.menu, li]
cy.get('.active').parentsUntil('.nav')

Rules

Requirements {% helper_icon requirements %}

{% requirements dom .parentsUntil %}

Assertions {% helper_icon assertions %}

{% assertions existence .parentsUntil %}

Timeouts {% helper_icon timeout %}

{% timeouts existence .parentsUntil %}

Command Log

Find all of the active element's ancestors until .nav

cy.get('.active').parentsUntil('.nav')

The commands above will display in the command log as:

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

See also

• {% url .parent() parent %}
• {% url .parents() parents %}
• {% url .prevUntil() prevuntil %}
• {% url .nextUntil() nextuntil %}