Parent commands in Cypress

Introduction

Parent commands help you find the parent element of a selected element on a web page. This is useful to check or interact with the container or group that holds the element.

When you want to check the style or attribute of a container around a button or link.

When you need to find a form or section that holds a specific input field.

When you want to click or verify something on the parent element of a selected item.

When you want to make sure the parent element has certain text or class.

When you want to chain commands starting from a child element to its parent.

Syntax

Cypress

cy.get('child-selector').parent([selector])

The parent() command gets the direct parent of the element found by get().

You can optionally pass a selector to filter the parent element.

Examples

Finds the button element, then gets its direct parent element.

Cypress

cy.get('button').parent()

Finds elements with class item, then gets their parent only if it has class container.

Cypress

cy.get('.item').parent('.container')

Finds the element with id input1, then gets its direct parent element.

Cypress

cy.get('#input1').parent()

Sample Program

This test visits a sample page, finds a button with class traversal-button, then checks if its parent has the class btn-group.

Cypress

describe('Parent command example', () => {
  it('checks parent element class', () => {
    cy.visit('https://example.cypress.io/commands/traversal')
    cy.get('.traversal-button').parent().should('have.class', 'btn-group')
  })
})

Important Notes

The parent() command only gets the direct parent, not ancestors higher up.

If no parent matches the optional selector, the command will fail.

Use parents() if you want to get all ancestors instead of just the direct parent.

Summary

Parent commands help find the direct parent of an element.

You can check or interact with the parent element easily.

Use optional selectors to filter the parent element.

Practice

1. What does the Cypress parent() command do?

easy

A. It finds the direct parent element of the current element.

B. It finds all child elements inside the current element.

C. It clicks on the current element.

D. It waits for the element to appear on the page.

Solution

1. Step 1: Understand the purpose of parent()

   The parent() command in Cypress is used to get the immediate parent of the selected element in the DOM tree.

2. Step 2: Compare with other options

   Options A, B, and D describe different commands or actions unrelated to parent(). Only It finds the direct parent element of the current element. correctly describes the direct parent selection.

3. Final Answer:

   It finds the direct parent element of the current element. -> Option A

4. Quick Check:

   parent() = direct parent element [OK]

Hint: Remember: parent() gets one level up in the DOM tree [OK]

Common Mistakes:

• Confusing parent() with children()
• Thinking parent() clicks the element
• Assuming parent() waits for elements

2. Which of the following is the correct syntax to get the parent of an element with class child-item in Cypress?

easy

A. cy.get('.child-item').children();

B. cy.get('.child-item').parents();

C. cy.get('.child-item').parent('.parent-item');

D. cy.get('.child-item').parent();

Solution

1. Step 1: Identify the basic parent command syntax

   The basic syntax to get the direct parent is cy.get(selector).parent();. This returns the immediate parent element.

2. Step 2: Analyze options

   cy.get('.child-item').parents(); uses parents() which gets all ancestors, not just the direct parent. cy.get('.child-item').parent('.parent-item'); filters the direct parent to only those matching '.parent-item', but the question does not specify the parent's class. cy.get('.child-item').children(); gets children, not parent.

3. Final Answer:

   cy.get('.child-item').parent(); -> Option D

4. Quick Check:

   Correct syntax = cy.get(...).parent() [OK]

Hint: Use parent() without arguments for direct parent [OK]

Common Mistakes:

• Using parents() instead of parent()
• Trying to pass selector directly inside parent() incorrectly
• Confusing children() with parent()

3. What will the following Cypress code select?

cy.get('.list-item').parent('.list-container').should('have.class', 'active');

medium

A. All parents of '.list-item' with class 'list-container' regardless of other classes.

B. The direct parent of '.list-item' that has class 'list-container' and also has class 'active'.

C. The child elements of '.list-item' with class 'active'.

D. The '.list-item' elements themselves if they have class 'active'.

Solution

1. Step 1: Understand the parent() with selector

   The parent('.list-container') command filters the direct parent to only those with class list-container.

2. Step 2: Understand the assertion

   The should('have.class', 'active') asserts that the selected parent element also has the class active.

3. Final Answer:

   The direct parent of '.list-item' that has class 'list-container' and also has class 'active'. -> Option B

4. Quick Check:

   parent(selector) filters direct parent [OK]

Hint: parent(selector) filters direct parent by selector [OK]

Common Mistakes:

• Thinking parents() selects only direct parent
• Confusing child elements with parent elements
• Ignoring the filter selector in parent()

4. You wrote this Cypress code but it fails:

cy.get('.button').parent('.container').click();

What is the likely cause of the failure?

medium

A. The parent element with class 'container' does not exist directly above '.button'.

B. The parent() command cannot be chained with click().

C. The selector '.button' is invalid.

D. You must use parents() instead of parent().

Solution

1. Step 1: Check the parent selector usage

   The parent('.container') filters the direct parent to only those with class 'container'. If no direct parent matches, the command yields no element.

2. Step 2: Understand why click() fails

   Since no element is found, click() fails because it has nothing to act on.

3. Final Answer:

   The parent element with class 'container' does not exist directly above '.button'. -> Option A

4. Quick Check:

   parent(selector) fails if no direct parent matches [OK]

Hint: Check if direct parent matches selector before chaining actions [OK]

Common Mistakes:

• Assuming parent() always finds an element
• Thinking click() can't chain after parent()
• Using parents() unnecessarily

5. You want to verify that a button with class submit-btn is inside a form with class user-form. Which Cypress code correctly checks the form is the direct parent of the button?

hard

A. cy.get('.user-form').children('.submit-btn').should('exist');

B. cy.get('.submit-btn').parents('form.user-form').should('exist');

C. cy.get('.submit-btn').parent('form.user-form').should('exist');

D. cy.get('.submit-btn').parent().should('have.class', 'user-form');

Solution

1. Step 1: Understand direct parent check

   To check if the direct parent matches a selector, use parent(selector). cy.get('.submit-btn').parent('form.user-form').should('exist'); uses this correctly.

2. Step 2: Compare other options

   cy.get('.submit-btn').parents('form.user-form').should('exist'); checks all ancestors, not just direct parent. cy.get('.user-form').children('.submit-btn').should('exist'); checks children of the form, reversed logic. cy.get('.submit-btn').parent().should('have.class', 'user-form'); checks parent but does not filter by selector, so it may pass incorrectly.

3. Final Answer:

   cy.get('.submit-btn').parent('form.user-form').should('exist'); -> Option C

4. Quick Check:

   parent(selector) verifies direct parent matches selector [OK]

Hint: Use parent(selector) to confirm direct parent matches [OK]

Common Mistakes:

• Using parents() when only direct parent matters
• Checking children instead of parent
• Not filtering parent by selector