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

title, comments

title	comments
siblings	false

Get sibling DOM elements.

Syntax

.siblings()
.siblings(selector)
.siblings(options)
.siblings(selector, options)

Usage

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

cy.get('td').siblings()           // Yield all td's siblings
cy.get('li').siblings('.active')  // Yield all li's siblings with class '.active'

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

cy.siblings('.error')     // Errors, cannot be chained off 'cy'
cy.location().siblings()  // Errors, 'location' 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 .siblings().

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

Yields {% helper_icon yields %}

{% yields changes_dom_subject .siblings %}

Examples

Siblings

Get the siblings of each li

<ul>
  <li>Home</li>
  <li>Contact</li>
  <li class="active">Services</li>
  <li>Price</li>
</ul>

// yields all other li's in list
cy.get('.active').siblings()

Selector

Get siblings of element with class active

// yields <li class="active">Services</li>
cy.get('li').siblings('.active')

Rules

Requirements {% helper_icon requirements %}

{% requirements dom .siblings %}

Assertions {% helper_icon assertions %}

{% assertions existence .siblings %}

Timeouts {% helper_icon timeout %}

{% timeouts existence .siblings %}

Command Log

Get the siblings of element with class active

cy.get('.left-nav').find('li.active').siblings()

The commands above will display in the command log as:

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

See also

• {% url .prev() prev %}
• {% url .next() next %}