diff --git a/docs/accessibility/changelog.mdx b/docs/accessibility/changelog.mdx index 86b1d768d7..5345070b9f 100644 --- a/docs/accessibility/changelog.mdx +++ b/docs/accessibility/changelog.mdx @@ -5,6 +5,8 @@ sidebar_label: Changelog sidebar_position: 200 --- + + # Changelog ## Week of 11/11/2024 diff --git a/docs/accessibility/configuration/axe-core-configuration.mdx b/docs/accessibility/configuration/axe-core-configuration.mdx index 45cddca7a9..ad95a91164 100644 --- a/docs/accessibility/configuration/axe-core-configuration.mdx +++ b/docs/accessibility/configuration/axe-core-configuration.mdx @@ -4,9 +4,9 @@ description: 'Configuration for Axe-Core® rules can be configured.' sidebar_label: 'Axe Core® configuration' --- -# Axe Core® configuration + - +# Axe Core® configuration Configuration for Axe-Core® rules is available through your Account Executive. We are happy to have a call with you to dial in your report config to make sure you are getting the most useful reports possible, and we find this onboarding very effective. diff --git a/docs/accessibility/configuration/elementfilters.mdx b/docs/accessibility/configuration/elementfilters.mdx index f0954ebba0..f228640e1d 100644 --- a/docs/accessibility/configuration/elementfilters.mdx +++ b/docs/accessibility/configuration/elementfilters.mdx @@ -5,9 +5,9 @@ sidebar_label: elementFilters sidebar_position: 20 --- -# elementFilters + - +# elementFilters :::info diff --git a/docs/accessibility/configuration/overview.mdx b/docs/accessibility/configuration/overview.mdx index 467d9833dd..32acf9053d 100644 --- a/docs/accessibility/configuration/overview.mdx +++ b/docs/accessibility/configuration/overview.mdx @@ -5,9 +5,9 @@ description: 'Configuration allows you to customize and fine-tune Accessibility sidebar_position: 10 --- -# Configuration + - +# Configuration Configuration allows you to customize and fine-tune Accessibility in Cypress. While Accessibility is designed to work seamlessly out of the box, there are instances where custom configuration may be necessary to address unique application structures, testing requirements, or edge cases. This section guides you through setting configuration to enhance the functionality and accuracy of Accessibility. diff --git a/docs/accessibility/configuration/viewfilters.mdx b/docs/accessibility/configuration/viewfilters.mdx index a4cfa40a79..530f3ee6eb 100644 --- a/docs/accessibility/configuration/viewfilters.mdx +++ b/docs/accessibility/configuration/viewfilters.mdx @@ -5,9 +5,9 @@ sidebar_label: viewFilters sidebar_position: 30 --- -# viewFilters + - +# viewFilters :::info Note: setting `viewFilters` impacts both Accessibility and UI Coverage reports. diff --git a/docs/accessibility/configuration/views.mdx b/docs/accessibility/configuration/views.mdx index 76a92d74da..2aaef430a2 100644 --- a/docs/accessibility/configuration/views.mdx +++ b/docs/accessibility/configuration/views.mdx @@ -5,9 +5,9 @@ sidebar_label: views sidebar_position: 40 --- -# views + - +# views :::info Note: setting views impacts both Accessibility and UI Coverage reports. diff --git a/docs/accessibility/core-concepts/accessibility-score.mdx b/docs/accessibility/core-concepts/accessibility-score.mdx index 557914068f..b951770f18 100644 --- a/docs/accessibility/core-concepts/accessibility-score.mdx +++ b/docs/accessibility/core-concepts/accessibility-score.mdx @@ -5,9 +5,9 @@ sidebar_label: Accessibility score sidebar_position: 30 --- -# Accessibility score + - +# Accessibility score Cypress provides a top-line percentage score to give a general sense of accessibility for your project. This score, calculated for a run, reflects the **average score** of **all application snapshots** captured during the run. It is based on the ratio of passing versus failing accessibility checks for each snapshot, with results weighted by the severity of the issues. diff --git a/docs/accessibility/core-concepts/how-it-works.mdx b/docs/accessibility/core-concepts/how-it-works.mdx index 780c2cdfb5..e37b872662 100644 --- a/docs/accessibility/core-concepts/how-it-works.mdx +++ b/docs/accessibility/core-concepts/how-it-works.mdx @@ -5,6 +5,8 @@ sidebar_label: 'How it works' sidebar_position: 40 --- + + # How it works Cypress Accessibility seamlessly integrates accessibility testing into your development pipeline. Below are the stages of the Cypress Accessibility process: diff --git a/docs/accessibility/core-concepts/inspecting-violation-details.mdx b/docs/accessibility/core-concepts/inspecting-violation-details.mdx index 3305e6dd02..5863044d15 100644 --- a/docs/accessibility/core-concepts/inspecting-violation-details.mdx +++ b/docs/accessibility/core-concepts/inspecting-violation-details.mdx @@ -5,9 +5,9 @@ sidebar_label: Inspecting violation details sidebar_position: 20 --- -# Inspecting violation details + - +# Inspecting violation details After navigating to a specific Rule of View from a [Run-level report](/accessibility/core-concepts/run-level-reports), you'll land on the Violation Detail view. diff --git a/docs/accessibility/core-concepts/run-level-reports.mdx b/docs/accessibility/core-concepts/run-level-reports.mdx index 6b1adaa0dc..fb2e1b6440 100644 --- a/docs/accessibility/core-concepts/run-level-reports.mdx +++ b/docs/accessibility/core-concepts/run-level-reports.mdx @@ -5,9 +5,9 @@ sidebar_position: 10 sidebar_label: Run-level reports --- -# Run-level reports + - +# Run-level reports This guide highlights the three main areas to focus on when reviewing an accessibility report for a Cypress run. It also explains key terms and definitions used in these reports. diff --git a/docs/accessibility/get-started/introduction.mdx b/docs/accessibility/get-started/introduction.mdx index d9e1f74d31..2c0cc18e24 100644 --- a/docs/accessibility/get-started/introduction.mdx +++ b/docs/accessibility/get-started/introduction.mdx @@ -6,7 +6,9 @@ sidebar_position: 10 sidebar_custom_props: { 'new_label': true } --- -# Cypress Accessibility + Add-on + + +# Automated accessibility checks on every test Instantly visualize, triage, and fix accessibility violations without any additional code or configuration. Dive deep into each violation with live, fully-rendered DOM snapshots of your application as it appeared during your tests. diff --git a/docs/accessibility/get-started/setup.mdx b/docs/accessibility/get-started/setup.mdx index c26965b322..6883c4ff9f 100644 --- a/docs/accessibility/get-started/setup.mdx +++ b/docs/accessibility/get-started/setup.mdx @@ -5,6 +5,8 @@ description: 'Set up Cypress Accessibility by recording a run. No code changes o sidebar_position: 20 --- + + # Get Started You don't need to make any changes to your code or your test setup. If you record test runs to the Cypress Cloud with Test Replay, you're ready to start using Cypress Accessibility. diff --git a/docs/accessibility/guides/accessibility-automation.mdx b/docs/accessibility/guides/accessibility-automation.mdx index 054b625989..c7e3e34034 100644 --- a/docs/accessibility/guides/accessibility-automation.mdx +++ b/docs/accessibility/guides/accessibility-automation.mdx @@ -2,10 +2,12 @@ sidebar_label: Accessibility automation principles title: 'Accessibility automation principles | Cypress Accessibility Documentation' description: " -Apply these core principles to maximize the impact of Cypress Accessibility’s automation: complement automation with human judgment for deeper insights, manage false positives effectively, and ensure robust assistive technology support." +Apply these core principles to maximize the impact of Cypress Accessibility's automation: complement automation with human judgment for deeper insights, manage false positives effectively, and ensure robust assistive technology support." sidebar_position: 80 --- + + # Accessibility automation principles This guide outlines foundational concepts for using Cypress Accessibility, which also apply to accessibility automation tools in general. diff --git a/docs/accessibility/guides/block-pull-requests.mdx b/docs/accessibility/guides/block-pull-requests.mdx index ec608e23f4..6174c0620e 100644 --- a/docs/accessibility/guides/block-pull-requests.mdx +++ b/docs/accessibility/guides/block-pull-requests.mdx @@ -5,6 +5,8 @@ description: "Set policies and block pull requests automatically with Cypress Ac sidebar_position: 40 --- + + # Block pull requests and set policies Cypress Accessibility reports are generated server-side in Cypress Cloud, based on test artifacts uploaded during execution. This ensures there is no performance impact on your Cypress test runs. diff --git a/docs/accessibility/guides/improve-accessibility.mdx b/docs/accessibility/guides/improve-accessibility.mdx index 7e870b74f4..0fb4fa2513 100644 --- a/docs/accessibility/guides/improve-accessibility.mdx +++ b/docs/accessibility/guides/improve-accessibility.mdx @@ -5,6 +5,8 @@ description: 'Discover how to break down accessibility reports, prioritize fixes sidebar_position: 20 --- + + # Improve accessibility This guide explains how to break down accessibility reports and create a focused plan for remediation using Cypress Accessibility. diff --git a/docs/accessibility/guides/introduction.mdx b/docs/accessibility/guides/introduction.mdx index 1cb85bdddb..0e9c67cb7c 100644 --- a/docs/accessibility/guides/introduction.mdx +++ b/docs/accessibility/guides/introduction.mdx @@ -1,8 +1,13 @@ --- title: Introduction +description: Learn how to set goals and make progress using Cypress Accessibility, generate reports during local development cycles, and monitor a production website. sidebar_position: 10 --- + + +# Introduction + :::info ##### What you'll learn diff --git a/docs/accessibility/guides/local-development.mdx b/docs/accessibility/guides/local-development.mdx index 03f1f889bd..587ec58455 100644 --- a/docs/accessibility/guides/local-development.mdx +++ b/docs/accessibility/guides/local-development.mdx @@ -5,6 +5,8 @@ description: 'Get precise, fast, and scoped accessibility feedback during local sidebar_position: 50 --- + + # Feedback during local development For reliable accessibility feedback during local development, the best approach is recording your tests directly to Cypress Cloud. By running tests related to your changes locally, you can bypass build pipelines and CI processes entirely. This can be achieved with a single command: diff --git a/docs/accessibility/guides/maintain-accessibility.mdx b/docs/accessibility/guides/maintain-accessibility.mdx index 0b18887624..6c08f73a10 100644 --- a/docs/accessibility/guides/maintain-accessibility.mdx +++ b/docs/accessibility/guides/maintain-accessibility.mdx @@ -5,6 +5,8 @@ description: 'Learn how to maintain long-term accessibility with Cypress, using sidebar_position: 30 --- + + # Maintain accessibility Accessibility isn't a one-time project—it's a continuous process. This guide explains how to transition from addressing known issues to maintaining long-term accessibility in your projects. diff --git a/docs/accessibility/guides/maximize-coverage.mdx b/docs/accessibility/guides/maximize-coverage.mdx index b63884cd57..5ea870071c 100644 --- a/docs/accessibility/guides/maximize-coverage.mdx +++ b/docs/accessibility/guides/maximize-coverage.mdx @@ -5,6 +5,8 @@ description: "Expand accessibility testing by combining Cypress Accessibility's sidebar_position: 70 --- + + # Maximize coverage As you become more familiar with accessibility violations and their underlying principles, you'll notice the connection between generic, automated checks (e.g., Axe Core®) and the specific user-facing behaviors of your application. Often, the insights gained from Cypress Accessibility's automated checks can guide you to create custom assertions tailored to your application's unique requirements. diff --git a/docs/accessibility/guides/production-monitoring.mdx b/docs/accessibility/guides/production-monitoring.mdx index ec807cba4b..a8f03ba38d 100644 --- a/docs/accessibility/guides/production-monitoring.mdx +++ b/docs/accessibility/guides/production-monitoring.mdx @@ -5,6 +5,8 @@ description: 'Monitor accessibility issues in production by running scheduled Cy sidebar_position: 60 --- + + # Production monitoring Cypress is commonly used in CI and local development workflows. It can also be leveraged to monitor production or staging environments through scheduled tests. This approach is particularly useful for environments involving dynamic content, such as those managed by Content Management Systems (CMS), where content changes can impact accessibility. diff --git a/docs/accessibility/results-api.mdx b/docs/accessibility/results-api.mdx index 7003e059b6..a2e8f214c8 100644 --- a/docs/accessibility/results-api.mdx +++ b/docs/accessibility/results-api.mdx @@ -5,9 +5,9 @@ sidebar_label: Results API sidebar_position: 100 --- -# Results API + - +# Results API The `@cypress/extract-cloud-results` module provides the `getAccessibilityResults` utility which enables you to programmatically fetch your run's Accessibility results in a CI environment. It determines the Cypress run created for the given CI workflow and will return the Accessibility results associated with that run. The results will be returned once the Cypress run has finished and the Accessibility report has been processed. diff --git a/docs/api/commands/and.mdx b/docs/api/commands/and.mdx index e87407fc66..3b9111f526 100644 --- a/docs/api/commands/and.mdx +++ b/docs/api/commands/and.mdx @@ -1,8 +1,14 @@ --- -title: and +title: 'and | Cypress Documentation' +description: 'Create an assertion. Assertions are automatically retried as part of the previous command until they pass or time out.' +sidebar_label: and slug: /api/commands/and --- + + +# and + Create an assertion. Assertions are automatically retried as part of the previous command until they pass or time out. diff --git a/docs/api/commands/as.mdx b/docs/api/commands/as.mdx index 9ce0434bf5..3496b46268 100644 --- a/docs/api/commands/as.mdx +++ b/docs/api/commands/as.mdx @@ -1,8 +1,14 @@ --- -title: as +title: 'as | Cypress Documentation' +description: Assign an alias for later use in Cypress. Reference the alias later within a `cy.get()` query or `cy.wait()` command with an `@` prefix. +sidebar_label: as slug: /api/commands/as --- + + +# as + Assign an alias for later use. Reference the alias later within a [`cy.get()`](/api/commands/get) query or [`cy.wait()`](/api/commands/wait) command with an `@` prefix. diff --git a/docs/api/commands/blur.mdx b/docs/api/commands/blur.mdx index ebeb6062e5..36c264f26f 100644 --- a/docs/api/commands/blur.mdx +++ b/docs/api/commands/blur.mdx @@ -1,7 +1,13 @@ --- -title: blur +title: 'blur | Cypress Documentation' +description: Blur a focused element in Cypress. +sidebar_label: blur --- + + +# blur + Blur a focused element. It is [unsafe](/app/core-concepts/retry-ability#Only-queries-are-retried) to diff --git a/docs/api/commands/check.mdx b/docs/api/commands/check.mdx index 2c87830766..392ecbaf7b 100644 --- a/docs/api/commands/check.mdx +++ b/docs/api/commands/check.mdx @@ -1,8 +1,14 @@ --- -title: check +title: 'check | Cypress Documentation' +description: Check checkbox(es) or radio(s) in Cypress. +sidebar_label: check slug: /api/commands/check --- + + +# check + Check checkbox(es) or radio(s). It is [unsafe](/app/core-concepts/retry-ability#Only-queries-are-retried) to diff --git a/docs/api/commands/children.mdx b/docs/api/commands/children.mdx index c99140957c..f5e079d8bf 100644 --- a/docs/api/commands/children.mdx +++ b/docs/api/commands/children.mdx @@ -1,8 +1,14 @@ --- -title: children +title: 'children | Cypress Documentation' +description: Get the children of each DOM element within a set of DOM elements in Cypress. +sidebar_label: children slug: /api/commands/children --- + + +# children + Get the children of each DOM element within a set of DOM elements. :::info diff --git a/docs/api/commands/clear.mdx b/docs/api/commands/clear.mdx index e2e5901c26..83e9e7a09c 100644 --- a/docs/api/commands/clear.mdx +++ b/docs/api/commands/clear.mdx @@ -1,8 +1,14 @@ --- -title: clear +title: 'clear | Cypress Documentation' +description: Clear the value of an input or textarea in Cypress. +sidebar_label: clear slug: /api/commands/clear --- + + +# clear + Clear the value of an `input` or `textarea`. It is [unsafe](/app/core-concepts/retry-ability#Only-queries-are-retried) to diff --git a/docs/api/commands/clearallcookies.mdx b/docs/api/commands/clearallcookies.mdx index 913b83c389..266ba66932 100644 --- a/docs/api/commands/clearallcookies.mdx +++ b/docs/api/commands/clearallcookies.mdx @@ -1,7 +1,13 @@ --- -title: clearAllCookies +title: 'clearAllCookies | Cypress Documentation' +description: Clear all browser cookies in Cypress. +sidebar_label: clearAllCookies --- + + +# clearAllCookies + Clear all browser cookies. :::caution diff --git a/docs/api/commands/clearalllocalstorage.mdx b/docs/api/commands/clearalllocalstorage.mdx index 507c1a0411..272d62254b 100644 --- a/docs/api/commands/clearalllocalstorage.mdx +++ b/docs/api/commands/clearalllocalstorage.mdx @@ -1,7 +1,13 @@ --- -title: clearAllLocalStorage +title: 'clearAllLocalStorage | Cypress Documentation' +description: Clear all localStorage data in Cypress. +sidebar_label: clearAllLocalStorage --- + + +# clearAllLocalStorage + Clear [`localStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) data for all origins with which the test has interacted. diff --git a/docs/api/commands/clearallsessionstorage.mdx b/docs/api/commands/clearallsessionstorage.mdx index 3e97552a89..a379fa44a7 100644 --- a/docs/api/commands/clearallsessionstorage.mdx +++ b/docs/api/commands/clearallsessionstorage.mdx @@ -1,7 +1,13 @@ --- -title: clearAllSessionStorage +title: 'clearAllSessionStorage | Cypress Documentation' +description: Clear all session storage data in Cypress. +sidebar_label: clearAllSessionStorage --- + + +# clearAllSessionStorage + Clear [`sessionStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage) data for all origins with which the test has interacted. diff --git a/docs/api/commands/clearcookie.mdx b/docs/api/commands/clearcookie.mdx index 15e37dcc0b..0dff42c628 100644 --- a/docs/api/commands/clearcookie.mdx +++ b/docs/api/commands/clearcookie.mdx @@ -1,7 +1,13 @@ --- -title: clearCookie +title: 'clearCookie | Cypress Documentation' +description: Clear a specific browser cookie in Cypress. +sidebar_label: clearCookie --- + + +# clearCookie + Clear a specific browser cookie. :::caution diff --git a/docs/api/commands/clearcookies.mdx b/docs/api/commands/clearcookies.mdx index 71f48b1ac0..64679372db 100644 --- a/docs/api/commands/clearcookies.mdx +++ b/docs/api/commands/clearcookies.mdx @@ -1,7 +1,13 @@ --- -title: clearCookies +title: 'clearCookies | Cypress Documentation' +description: Clear browser cookies for a domain in Cypress. +sidebar_label: clearCookies --- + + +# clearCookies + Clear browser cookies for a domain. :::caution diff --git a/docs/api/commands/clearlocalstorage.mdx b/docs/api/commands/clearlocalstorage.mdx index 82b506e2e0..1413f604ff 100644 --- a/docs/api/commands/clearlocalstorage.mdx +++ b/docs/api/commands/clearlocalstorage.mdx @@ -1,7 +1,13 @@ --- -title: clearLocalStorage +title: 'clearLocalStorage | Cypress Documentation' +description: Clear data in localStorage for current domain and subdomain in Cypress. +sidebar_label: clearLocalStorage --- + + +# clearLocalStorage + Clear data in localStorage for current domain and subdomain. :::caution diff --git a/docs/api/commands/click.mdx b/docs/api/commands/click.mdx index 2f8bacdec0..1f60283d82 100644 --- a/docs/api/commands/click.mdx +++ b/docs/api/commands/click.mdx @@ -1,8 +1,14 @@ --- -title: click +title: 'click | Cypress Documentation' +description: Click a DOM element in Cypress. +sidebar_label: click slug: /api/commands/click --- + + +# click + Click a DOM element. It is [unsafe](/app/core-concepts/retry-ability#Only-queries-are-retried) to diff --git a/docs/api/commands/clock.mdx b/docs/api/commands/clock.mdx index bdc0e1d040..0b8937bb6a 100644 --- a/docs/api/commands/clock.mdx +++ b/docs/api/commands/clock.mdx @@ -1,7 +1,13 @@ --- -title: clock +title: 'clock | Cypress Documentation' +description: Override native global functions related to time allowing them to be controlled synchronously via `cy.tick()` or the yielded `clock` object. +sidebar_label: clock --- + + +# clock + `cy.clock()` overrides native global functions related to time allowing them to be controlled synchronously via [`cy.tick()`](/api/commands/tick) or the yielded `clock` object. This includes controlling: diff --git a/docs/api/commands/closest.mdx b/docs/api/commands/closest.mdx index 8c6d40fe74..cde1116dfc 100644 --- a/docs/api/commands/closest.mdx +++ b/docs/api/commands/closest.mdx @@ -1,8 +1,14 @@ --- -title: closest +title: 'closest | Cypress Documentation' +description: Get the first DOM element that matches the selector in Cypress (whether it be itself or one of its ancestors). +sidebar_label: closest slug: /api/commands/closest --- + + +# closest + Get the first DOM element that matches the selector (whether it be itself or one of its ancestors). diff --git a/docs/api/commands/contains.mdx b/docs/api/commands/contains.mdx index 44f30e62b0..67f440390a 100644 --- a/docs/api/commands/contains.mdx +++ b/docs/api/commands/contains.mdx @@ -1,8 +1,14 @@ --- -title: contains +title: 'contains | Cypress Documentation' +description: Get the DOM element containing the text in Cypress. +sidebar_label: contains slug: /api/commands/contains --- + + +# contains + Get the DOM element containing the text. DOM elements can contain _more_ than the desired text and still match. Additionally, Cypress [prefers some DOM elements](#Notes) over the deepest element found. diff --git a/docs/api/commands/dblclick.mdx b/docs/api/commands/dblclick.mdx index aadddaa0fe..e17d1486a0 100644 --- a/docs/api/commands/dblclick.mdx +++ b/docs/api/commands/dblclick.mdx @@ -1,8 +1,14 @@ --- -title: dblclick +title: 'dblclick | Cypress Documentation' +description: Double-click a DOM element in Cypress. +sidebar_label: dblclick slug: /api/commands/dblclick --- + + +# dblclick + Double-click a DOM element. It is [unsafe](/app/core-concepts/retry-ability#Only-queries-are-retried) to diff --git a/docs/api/commands/debug.mdx b/docs/api/commands/debug.mdx index aa9019b46c..46a029a911 100644 --- a/docs/api/commands/debug.mdx +++ b/docs/api/commands/debug.mdx @@ -1,8 +1,14 @@ --- -title: debug +title: 'debug | Cypress Documentation' +description: Set a `debugger` in Cypress and log what the previous command yields. +sidebar_label: debug slug: /api/commands/debug --- + + +# debug + Set a `debugger` and log what the previous command yields. :::caution diff --git a/docs/api/commands/document.mdx b/docs/api/commands/document.mdx index cb54f2c596..b9ec82daed 100644 --- a/docs/api/commands/document.mdx +++ b/docs/api/commands/document.mdx @@ -1,8 +1,14 @@ --- -title: document +title: 'document | Cypress Documentation' +description: Get the `window.document` of the page that is currently active. +sidebar_label: document slug: /api/commands/document --- + + +# document + Get the `window.document` of the page that is currently active. ## Syntax diff --git a/docs/api/commands/each.mdx b/docs/api/commands/each.mdx index 2509731e84..9a8ddadfa8 100644 --- a/docs/api/commands/each.mdx +++ b/docs/api/commands/each.mdx @@ -1,7 +1,13 @@ --- -title: each +title: 'each | Cypress Documentation' +description: Iterate through an array like structure in Cypress (arrays or objects with a `length` property). +sidebar_label: each --- + + +# each + Iterate through an array like structure (arrays or objects with a `length` property). diff --git a/docs/api/commands/end.mdx b/docs/api/commands/end.mdx index 9055e7a2ee..84743a5e48 100644 --- a/docs/api/commands/end.mdx +++ b/docs/api/commands/end.mdx @@ -1,7 +1,13 @@ --- -title: end +title: 'end | Cypress Documentation' +description: End a chain of commands in Cypress. +sidebar_label: end --- + + +# end + End a chain of commands. ## Syntax diff --git a/docs/api/commands/eq.mdx b/docs/api/commands/eq.mdx index 938c6e5208..2a92772ee4 100644 --- a/docs/api/commands/eq.mdx +++ b/docs/api/commands/eq.mdx @@ -1,8 +1,14 @@ --- -title: eq +title: 'eq | Cypress Documentation' +description: Get a DOM element at a specific index in an array of elements in Cypress. +sidebar_label: eq slug: /api/commands/eq --- + + +# eq + Get A DOM element at a specific index in an array of elements. :::info diff --git a/docs/api/commands/exec.mdx b/docs/api/commands/exec.mdx index 8fdbb096ee..a1ecf80538 100644 --- a/docs/api/commands/exec.mdx +++ b/docs/api/commands/exec.mdx @@ -1,7 +1,13 @@ --- -title: exec +title: 'exec | Cypress Documentation' +description: Execute a system command in Cypress. +sidebar_label: exec --- + + +# exec + Execute a system command. :::caution diff --git a/docs/api/commands/filter.mdx b/docs/api/commands/filter.mdx index c75b76a8e9..0e0c246064 100644 --- a/docs/api/commands/filter.mdx +++ b/docs/api/commands/filter.mdx @@ -1,8 +1,14 @@ --- -title: filter +title: 'filter | Cypress Documentation' +description: Get the DOM elements that match a specific selector in Cypress. +sidebar_label: filter slug: /api/commands/filter --- + + +# filter + Get the DOM elements that match a specific selector. :::info diff --git a/docs/api/commands/find.mdx b/docs/api/commands/find.mdx index 908c3a3512..7cd6ede37e 100644 --- a/docs/api/commands/find.mdx +++ b/docs/api/commands/find.mdx @@ -1,8 +1,14 @@ --- -title: find +title: 'find | Cypress Documentation' +description: Get the descendent DOM elements of a specific selector in Cypress. +sidebar_label: find slug: /api/commands/find --- + + +# find + Get the descendent DOM elements of a specific selector. :::info diff --git a/docs/api/commands/first.mdx b/docs/api/commands/first.mdx index 8944fefb2b..68df7c590a 100644 --- a/docs/api/commands/first.mdx +++ b/docs/api/commands/first.mdx @@ -1,8 +1,14 @@ --- -title: first +title: 'first | Cypress Documentation' +description: Get the first DOM element within a set of DOM elements in Cypress. +sidebar_label: first slug: /api/commands/first --- + + +# first + Get the first DOM element within a set of DOM elements. :::info diff --git a/docs/api/commands/fixture.mdx b/docs/api/commands/fixture.mdx index ad2d9a7f1a..a3e416bd1d 100644 --- a/docs/api/commands/fixture.mdx +++ b/docs/api/commands/fixture.mdx @@ -1,7 +1,13 @@ --- -title: fixture +title: 'fixture | Cypress Documentation' +description: Load a fixed set of data located in a file in Cypress. +sidebar_label: fixture --- + + +# fixture + Load a fixed set of data located in a file. ## Syntax diff --git a/docs/api/commands/focus.mdx b/docs/api/commands/focus.mdx index c3dfb8ff62..36024d875a 100644 --- a/docs/api/commands/focus.mdx +++ b/docs/api/commands/focus.mdx @@ -1,7 +1,13 @@ --- -title: focus +title: 'focus | Cypress Documentation' +description: Focus on a DOM element in Cypress. +sidebar_label: focus --- + + +# focus + Focus on a DOM element. It is [unsafe](/app/core-concepts/retry-ability#Only-queries-are-retried) to diff --git a/docs/api/commands/focused.mdx b/docs/api/commands/focused.mdx index 63201d81fa..59e873f6a6 100644 --- a/docs/api/commands/focused.mdx +++ b/docs/api/commands/focused.mdx @@ -1,8 +1,14 @@ --- -title: focused +title: 'focused | Cypress Documentation' +description: Get the DOM element that is currently focused in Cypress. +sidebar_label: focused slug: /api/commands/focused --- + + +# focused + Get the DOM element that is currently focused. ## Syntax diff --git a/docs/api/commands/get.mdx b/docs/api/commands/get.mdx index 223c06867a..d65aab2fb4 100644 --- a/docs/api/commands/get.mdx +++ b/docs/api/commands/get.mdx @@ -1,8 +1,14 @@ --- -title: get +title: 'get | Cypress Documentation' +description: Get one or more DOM elements by selector or alias in Cypress. +sidebar_label: get slug: /api/commands/get --- + + +# get + Get one or more DOM elements by selector or [alias](/app/core-concepts/variables-and-aliases). diff --git a/docs/api/commands/getallcookies.mdx b/docs/api/commands/getallcookies.mdx index f5bed09cb4..d7a15dc34b 100644 --- a/docs/api/commands/getallcookies.mdx +++ b/docs/api/commands/getallcookies.mdx @@ -1,7 +1,13 @@ --- -title: getAllCookies +title: 'getAllCookies | Cypress Documentation' +description: Get all browser cookies in Cypress. +sidebar_label: getAllCookies --- + + +# getAllCookies + Get all browser cookies. ## Syntax diff --git a/docs/api/commands/getalllocalstorage.mdx b/docs/api/commands/getalllocalstorage.mdx index c27ba22d96..3b9917df2f 100644 --- a/docs/api/commands/getalllocalstorage.mdx +++ b/docs/api/commands/getalllocalstorage.mdx @@ -1,7 +1,13 @@ --- -title: getAllLocalStorage +title: 'getAllLocalStorage | Cypress Documentation' +description: Get localStorage data for all origins with which the test has interacted in Cypress. +sidebar_label: getAllLocalStorage --- + + +# getAllLocalStorage + Get [`localStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) data for all origins with which the test has interacted. diff --git a/docs/api/commands/getallsessionstorage.mdx b/docs/api/commands/getallsessionstorage.mdx index 8e14b0de94..25165d16ad 100644 --- a/docs/api/commands/getallsessionstorage.mdx +++ b/docs/api/commands/getallsessionstorage.mdx @@ -1,7 +1,13 @@ --- -title: getAllSessionStorage +title: 'getAllSessionStorage | Cypress Documentation' +description: Get sessionStorage data for all origins with which the test has interacted in Cypress. +sidebar_label: getAllSessionStorage --- + + +# getAllSessionStorage + Get [`sessionStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage) data for all origins with which the test has interacted. diff --git a/docs/api/commands/getcookie.mdx b/docs/api/commands/getcookie.mdx index 3b9757079f..26c2b7e1ab 100644 --- a/docs/api/commands/getcookie.mdx +++ b/docs/api/commands/getcookie.mdx @@ -1,7 +1,13 @@ --- -title: getCookie +title: 'getCookie | Cypress Documentation' +description: Get a browser cookie by its name in Cypress. +sidebar_label: getCookie --- + + +# getCookie + Get a browser cookie by its name. ## Syntax diff --git a/docs/api/commands/getcookies.mdx b/docs/api/commands/getcookies.mdx index a1d861309c..cb18087ad3 100644 --- a/docs/api/commands/getcookies.mdx +++ b/docs/api/commands/getcookies.mdx @@ -1,7 +1,13 @@ --- -title: getCookies +title: 'getCookies | Cypress Documentation' +description: Get browser cookies for the current domain or the specified domain in Cypress. +sidebar_label: getCookies --- + + +# getCookies + Get browser cookies for the current domain or the specified domain. ## Syntax diff --git a/docs/api/commands/go.mdx b/docs/api/commands/go.mdx index f1c54a9cc1..1f53dcf8db 100644 --- a/docs/api/commands/go.mdx +++ b/docs/api/commands/go.mdx @@ -1,8 +1,14 @@ --- -title: go +title: 'go | Cypress Documentation' +description: Navigate back or forward to the previous or next URL in the browser's history in Cypress. +sidebar_label: go e2eSpecific: true --- + + +# go + Navigate back or forward to the previous or next URL in the browser's history. ## Syntax diff --git a/docs/api/commands/hash.mdx b/docs/api/commands/hash.mdx index c3373abaee..aee555eedd 100644 --- a/docs/api/commands/hash.mdx +++ b/docs/api/commands/hash.mdx @@ -1,9 +1,15 @@ --- -title: hash +title: 'hash | Cypress Documentation' +description: Get the current URL hash of the page that is currently active in Cypress. +sidebar_label: hash e2eSpecific: true slug: /api/commands/hash --- + + +# hash + Get the current URL hash of the page that is currently active. :::info diff --git a/docs/api/commands/hover.mdx b/docs/api/commands/hover.mdx index 3c9753ac1e..a65fb5aa35 100644 --- a/docs/api/commands/hover.mdx +++ b/docs/api/commands/hover.mdx @@ -1,7 +1,13 @@ --- -title: hover +title: 'hover | Cypress Documentation' +description: 'Cypress does not have a cy.hover() command: See common workarounds' +sidebar_label: hover --- + + +# hover + :::danger Cypress does not have a **cy.hover()** command. See diff --git a/docs/api/commands/intercept.mdx b/docs/api/commands/intercept.mdx index c35ce7dd32..59b7c25ebc 100644 --- a/docs/api/commands/intercept.mdx +++ b/docs/api/commands/intercept.mdx @@ -1,7 +1,13 @@ --- -title: intercept +title: 'intercept | Cypress Documentation' +description: Spy and stub network requests and responses. +sidebar_label: intercept --- + + +# intercept + Spy and stub network requests and responses. :::info diff --git a/docs/api/commands/invoke.mdx b/docs/api/commands/invoke.mdx index cca57983e6..088181847e 100644 --- a/docs/api/commands/invoke.mdx +++ b/docs/api/commands/invoke.mdx @@ -1,8 +1,14 @@ --- -title: invoke +title: 'invoke | Cypress Documentation' +description: Invoke a function on the previously yielded subject in Cypress. +sidebar_label: invoke slug: /api/commands/invoke --- + + +# invoke + Invoke a function on the previously yielded subject. :::info diff --git a/docs/api/commands/its.mdx b/docs/api/commands/its.mdx index 6fb13c5651..111efb5686 100644 --- a/docs/api/commands/its.mdx +++ b/docs/api/commands/its.mdx @@ -1,8 +1,14 @@ --- -title: its +title: 'its | Cypress Documentation' +description: Get a property's value on the previously yielded subject in Cypress. +sidebar_label: its slug: /api/commands/its --- + + +# its + Get a property's value on the previously yielded subject. :::info diff --git a/docs/api/commands/last.mdx b/docs/api/commands/last.mdx index b278ff1a4e..ec9b96032e 100644 --- a/docs/api/commands/last.mdx +++ b/docs/api/commands/last.mdx @@ -1,8 +1,14 @@ --- -title: last +title: 'last | Cypress Documentation' +description: Get the last DOM element within a set of DOM elements in Cypress. +sidebar_label: last slug: /api/commands/last --- + + +# last + Get the last DOM element within a set of DOM elements. :::info diff --git a/docs/api/commands/location.mdx b/docs/api/commands/location.mdx index a608a35794..cce09cb10c 100644 --- a/docs/api/commands/location.mdx +++ b/docs/api/commands/location.mdx @@ -1,9 +1,15 @@ --- -title: location +title: 'location | Cypress Documentation' +description: 'Get the global `window.location` object of the page that is currently active in Cypress.' +sidebar_label: location e2eSpecific: true slug: /api/commands/location --- + + +# location + Get the global `window.location` object of the page that is currently active. ## Syntax diff --git a/docs/api/commands/log.mdx b/docs/api/commands/log.mdx index 8ae24bf2db..d808a913e1 100644 --- a/docs/api/commands/log.mdx +++ b/docs/api/commands/log.mdx @@ -1,7 +1,14 @@ --- -title: log +title: 'log | Cypress Documentation' +description: Print a message to the Cypress Command Log. +sidebar_label: log +slug: /api/commands/log --- + + +# log + Print a message to the Cypress Command Log. ## Syntax diff --git a/docs/api/commands/mount.mdx b/docs/api/commands/mount.mdx index 3b480835df..d89c9c4942 100644 --- a/docs/api/commands/mount.mdx +++ b/docs/api/commands/mount.mdx @@ -1,8 +1,15 @@ --- -title: mount +title: 'mount | Cypress Documentation' +description: Set up a mount command in your support file for Cypress Component Testing +sidebar_label: mount +slug: /api/commands/mount componentSpecific: true --- + + +# mount + Cypress does not have a built-in `cy.mount()` command. The command must be set up in your support file. By default, when you use Cypress to configure your project, one will be automatically scaffolded for you. diff --git a/docs/api/commands/next.mdx b/docs/api/commands/next.mdx index ee65f83dcd..706f943aa2 100644 --- a/docs/api/commands/next.mdx +++ b/docs/api/commands/next.mdx @@ -1,8 +1,14 @@ --- -title: next +title: 'next | Cypress Documentation' +description: Get the immediately following sibling of each DOM element within a set of DOM elements in Cypress. +sidebar_label: next slug: /api/commands/next --- + + +# next + Get the immediately following sibling of each DOM element within a set of DOM elements. diff --git a/docs/api/commands/nextall.mdx b/docs/api/commands/nextall.mdx index 05ae19ab3c..c48b200742 100644 --- a/docs/api/commands/nextall.mdx +++ b/docs/api/commands/nextall.mdx @@ -1,8 +1,14 @@ --- -title: nextAll +title: 'nextAll | Cypress Documentation' +description: Get all following siblings of each DOM element in a set of matched DOM elements in Cypress. +sidebar_label: nextAll slug: /api/commands/nextall --- + + +# nextAll + Get all following siblings of each DOM element in a set of matched DOM elements. :::info diff --git a/docs/api/commands/nextuntil.mdx b/docs/api/commands/nextuntil.mdx index a45a33e937..c2ed4b0406 100644 --- a/docs/api/commands/nextuntil.mdx +++ b/docs/api/commands/nextuntil.mdx @@ -1,8 +1,14 @@ --- -title: nextUntil +title: 'nextUntil | Cypress Documentation' +description: Get all following siblings of each DOM element in a set of matched DOM elements up to, but not including, the element provided in Cypress. +sidebar_label: nextUntil slug: /api/commands/nextuntil --- + + +# nextUntil + Get all following siblings of each DOM element in a set of matched DOM elements up to, but not including, the element provided. diff --git a/docs/api/commands/not.mdx b/docs/api/commands/not.mdx index ac4ef4a613..33ddd28fa1 100644 --- a/docs/api/commands/not.mdx +++ b/docs/api/commands/not.mdx @@ -1,8 +1,14 @@ --- -title: not +title: 'not | Cypress Documentation' +description: Filter DOM element(s) from a set of DOM elements in Cypress. +sidebar_label: not slug: /api/commands/not --- + + +# not + Filter DOM element(s) from a set of DOM elements. :::info diff --git a/docs/api/commands/origin.mdx b/docs/api/commands/origin.mdx index 968aaedfaf..6ed658a35a 100644 --- a/docs/api/commands/origin.mdx +++ b/docs/api/commands/origin.mdx @@ -1,8 +1,14 @@ --- -title: origin +title: 'origin | Cypress Documentation' +description: Visit multiple domains of different origin in a single test in Cypress. +sidebar_label: origin e2eSpecific: true --- + + +# origin + Visit multiple domains of different [origin](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy#definition_of_an_origin) in a single test. diff --git a/docs/api/commands/parent.mdx b/docs/api/commands/parent.mdx index 4f6a1a75b5..067ca0a361 100644 --- a/docs/api/commands/parent.mdx +++ b/docs/api/commands/parent.mdx @@ -1,8 +1,14 @@ --- -title: parent +title: 'parent | Cypress Documentation' +description: Get the parent DOM element of a set of DOM elements in Cypress. +sidebar_label: parent slug: /api/commands/parent --- + + +# parent + Get the parent DOM element of a set of DOM elements. Please note that `.parent()` only travels a single level up the DOM tree as diff --git a/docs/api/commands/parents.mdx b/docs/api/commands/parents.mdx index 28863377ea..1692a13b3b 100644 --- a/docs/api/commands/parents.mdx +++ b/docs/api/commands/parents.mdx @@ -1,8 +1,14 @@ --- -title: parents +title: 'parents | Cypress Documentation' +description: Get the parent DOM elements of a set of DOM elements in Cypress. +sidebar_label: parents slug: /api/commands/parents --- + + +# parents + Get the parent DOM elements of a set of DOM elements. Please note that `.parents()` travels multiple levels up the DOM tree as opposed diff --git a/docs/api/commands/parentsuntil.mdx b/docs/api/commands/parentsuntil.mdx index a25ab04e75..52e0889d4f 100644 --- a/docs/api/commands/parentsuntil.mdx +++ b/docs/api/commands/parentsuntil.mdx @@ -1,8 +1,14 @@ --- -title: parentsUntil +title: 'parentsUntil | Cypress Documentation' +description: Get all ancestors of each DOM element in a set of matched DOM elements up to, but not including, the element provided in Cypress. +sidebar_label: parentsUntil slug: /api/commands/parentsuntil --- + + +# parentsUntil + Get all ancestors of each DOM element in a set of matched DOM elements up to, but not including, the element provided. diff --git a/docs/api/commands/pause.mdx b/docs/api/commands/pause.mdx index d1bb0a33e0..bbffd4946d 100644 --- a/docs/api/commands/pause.mdx +++ b/docs/api/commands/pause.mdx @@ -1,7 +1,14 @@ --- -title: pause +title: 'pause | Cypress Documentation' +description: Stop `cy` commands from running and allow interaction with the application under test. +sidebar_label: pause +slug: /api/commands/pause --- + + +# pause + Stop `cy` commands from running and allow interaction with the application under test. You can then "resume" running all commands or choose to step through the "next" commands from the Command Log. diff --git a/docs/api/commands/prev.mdx b/docs/api/commands/prev.mdx index 4535ea63b5..5f98e0e730 100644 --- a/docs/api/commands/prev.mdx +++ b/docs/api/commands/prev.mdx @@ -1,8 +1,14 @@ --- -title: prev +title: 'prev | Cypress Documentation' +description: Get the immediately preceding sibling of each element in a set of the elements in Cypress. +sidebar_label: prev slug: /api/commands/prev --- + + +# prev + Get the immediately preceding sibling of each element in a set of the elements. :::info diff --git a/docs/api/commands/prevall.mdx b/docs/api/commands/prevall.mdx index 9e2b76cf12..b96bdde488 100644 --- a/docs/api/commands/prevall.mdx +++ b/docs/api/commands/prevall.mdx @@ -1,8 +1,14 @@ --- -title: prevAll +title: 'prevAll | Cypress Documentation' +description: Get all previous siblings of each DOM element in a set of matched DOM elements in Cypress. +sidebar_label: prevAll slug: /api/commands/prevall --- + + +# prevAll + Get all previous siblings of each DOM element in a set of matched DOM elements. :::info diff --git a/docs/api/commands/prevuntil.mdx b/docs/api/commands/prevuntil.mdx index 660a82a8ac..f929e80cef 100644 --- a/docs/api/commands/prevuntil.mdx +++ b/docs/api/commands/prevuntil.mdx @@ -1,8 +1,14 @@ --- -title: prevUntil +title: 'prevUntil | Cypress Documentation' +description: Get all previous siblings of each DOM element in a set of matched DOM elements up to, but not including, the element provided in Cypress. +sidebar_label: prevUntil slug: /api/commands/prevuntil --- + + +# prevUntil + Get all previous siblings of each DOM element in a set of matched DOM elements up to, but not including, the element provided. diff --git a/docs/api/commands/readfile.mdx b/docs/api/commands/readfile.mdx index 9229b2ccda..90fd293fbf 100644 --- a/docs/api/commands/readfile.mdx +++ b/docs/api/commands/readfile.mdx @@ -1,8 +1,14 @@ --- -title: readFile +title: 'readFile | Cypress Documentation' +description: Read a file and yield its contents in Cypress. +sidebar_label: readFile slug: /api/commands/readfile --- + + +# readFile + Read a file and yield its contents. ## Syntax diff --git a/docs/api/commands/reload.mdx b/docs/api/commands/reload.mdx index adb047eb5b..f3f6573fc1 100644 --- a/docs/api/commands/reload.mdx +++ b/docs/api/commands/reload.mdx @@ -1,8 +1,14 @@ --- -title: reload +title: 'reload | Cypress Documentation' +description: Reload the page in Cypress. +sidebar_label: reload e2eSpecific: true --- + + +# reload + Reload the page. ## Syntax diff --git a/docs/api/commands/request.mdx b/docs/api/commands/request.mdx index da7b780750..07b06615b2 100644 --- a/docs/api/commands/request.mdx +++ b/docs/api/commands/request.mdx @@ -1,7 +1,14 @@ --- -title: request +title: 'request | Cypress Documentation' +description: Make an HTTP request in Cypress. +sidebar_label: request +slug: /api/commands/request --- + + +# request + Make an HTTP request. ## Syntax diff --git a/docs/api/commands/rightclick.mdx b/docs/api/commands/rightclick.mdx index 8d9aaaab96..73cb1e4de0 100644 --- a/docs/api/commands/rightclick.mdx +++ b/docs/api/commands/rightclick.mdx @@ -1,8 +1,14 @@ --- -title: rightclick +title: 'rightclick | Cypress Documentation' +description: Right click a DOM element in Cypress. +sidebar_label: rightclick slug: /api/commands/rightclick --- + + +# rightclick + Right click a DOM element. It is [unsafe](/app/core-concepts/retry-ability#Only-queries-are-retried) to diff --git a/docs/api/commands/root.mdx b/docs/api/commands/root.mdx index 89b74dfa67..8c04556e79 100644 --- a/docs/api/commands/root.mdx +++ b/docs/api/commands/root.mdx @@ -1,8 +1,14 @@ --- -title: root +title: 'root | Cypress Documentation' +description: Get the root DOM element in Cypress. +sidebar_label: root slug: /api/commands/root --- + + +# root + Get the root DOM element. ## Syntax diff --git a/docs/api/commands/screenshot.mdx b/docs/api/commands/screenshot.mdx index f9b67ebedd..5acee1ffdb 100644 --- a/docs/api/commands/screenshot.mdx +++ b/docs/api/commands/screenshot.mdx @@ -1,7 +1,13 @@ --- -title: screenshot +title: 'screenshot | Cypress Documentation' +description: Take a screenshot of the application under test and, optionally, the Cypress Command Log. +sidebar_label: screenshot --- + + +# screenshot + Take a screenshot of the application under test and, optionally, the [Cypress Command Log](/app/core-concepts/open-mode#Command-Log). diff --git a/docs/api/commands/scrollintoview.mdx b/docs/api/commands/scrollintoview.mdx index 89e07146ee..3f0fd09579 100644 --- a/docs/api/commands/scrollintoview.mdx +++ b/docs/api/commands/scrollintoview.mdx @@ -1,7 +1,13 @@ --- -title: scrollIntoView +title: 'scrollIntoView | Cypress Documentation' +description: Scroll an element into view in Cypress. +sidebar_label: scrollIntoView --- + + +# scrollIntoView + Scroll an element into view. It is [unsafe](/app/core-concepts/retry-ability#Only-queries-are-retried) to diff --git a/docs/api/commands/scrollto.mdx b/docs/api/commands/scrollto.mdx index 1d4161d2d2..b9e235dbc8 100644 --- a/docs/api/commands/scrollto.mdx +++ b/docs/api/commands/scrollto.mdx @@ -1,7 +1,13 @@ --- -title: scrollTo +title: 'scrollTo | Cypress Documentation' +description: Scroll to a specific position in the window or element in Cypress. +sidebar_label: scrollTo --- + + +# scrollTo + Scroll to a specific position. It is [unsafe](/app/core-concepts/retry-ability#Only-queries-are-retried) to diff --git a/docs/api/commands/select.mdx b/docs/api/commands/select.mdx index edae1e6d8f..6c0a7d5209 100644 --- a/docs/api/commands/select.mdx +++ b/docs/api/commands/select.mdx @@ -1,8 +1,14 @@ --- -title: select +title: 'select | Cypress Documentation' +description: 'Select an option within a select in Cypress.' +sidebar_label: select slug: /api/commands/select --- + + +# select + Select an `