diff --git a/assets/img/guides/references/cy-method-failed-element-is-detached.png b/assets/img/guides/references/cy-method-failed-element-is-detached.png deleted file mode 100644 index 955d85023a..0000000000 Binary files a/assets/img/guides/references/cy-method-failed-element-is-detached.png and /dev/null differ diff --git a/assets/img/guides/references/cypress-method-failed-page-updated.png b/assets/img/guides/references/cypress-method-failed-page-updated.png new file mode 100644 index 0000000000..3cc7e6bdfb Binary files /dev/null and b/assets/img/guides/references/cypress-method-failed-page-updated.png differ diff --git a/assets/img/guides/retry-ability/v10/click-twice.gif b/assets/img/guides/retry-ability/click-twice.gif similarity index 100% rename from assets/img/guides/retry-ability/v10/click-twice.gif rename to assets/img/guides/retry-ability/click-twice.gif diff --git a/assets/img/guides/retry-ability/command-assertions.png b/assets/img/guides/retry-ability/command-assertions.png new file mode 100644 index 0000000000..e9b001fc59 Binary files /dev/null and b/assets/img/guides/retry-ability/command-assertions.png differ diff --git a/assets/img/guides/retry-ability/v10/delay-click.png b/assets/img/guides/retry-ability/delay-click.png similarity index 100% rename from assets/img/guides/retry-ability/v10/delay-click.png rename to assets/img/guides/retry-ability/delay-click.png diff --git a/assets/img/guides/retry-ability/v10/eq.gif b/assets/img/guides/retry-ability/eq.gif similarity index 100% rename from assets/img/guides/retry-ability/v10/eq.gif rename to assets/img/guides/retry-ability/eq.gif diff --git a/assets/img/guides/retry-ability/v10/random-number-callback.gif b/assets/img/guides/retry-ability/random-number-callback.gif similarity index 100% rename from assets/img/guides/retry-ability/v10/random-number-callback.gif rename to assets/img/guides/retry-ability/random-number-callback.gif diff --git a/assets/img/guides/retry-ability/v10/random-number-first-attempt.png b/assets/img/guides/retry-ability/random-number-first-attempt.png similarity index 100% rename from assets/img/guides/retry-ability/v10/random-number-first-attempt.png rename to assets/img/guides/retry-ability/random-number-first-attempt.png diff --git a/assets/img/guides/retry-ability/v10/random-number.gif b/assets/img/guides/retry-ability/random-number.gif similarity index 100% rename from assets/img/guides/retry-ability/v10/random-number.gif rename to assets/img/guides/retry-ability/random-number.gif diff --git a/assets/img/guides/retry-ability/retry-assertion.gif b/assets/img/guides/retry-ability/retry-assertion.gif new file mode 100644 index 0000000000..a663d98fdd Binary files /dev/null and b/assets/img/guides/retry-ability/retry-assertion.gif differ diff --git a/assets/img/guides/retry-ability/v10/second-assertion-fails.gif b/assets/img/guides/retry-ability/second-assertion-fails.gif similarity index 100% rename from assets/img/guides/retry-ability/v10/second-assertion-fails.gif rename to assets/img/guides/retry-ability/second-assertion-fails.gif diff --git a/assets/img/guides/retry-ability/v10/adds-two-items-fails.gif b/assets/img/guides/retry-ability/v10/adds-two-items-fails.gif deleted file mode 100644 index b1cb82fbce..0000000000 Binary files a/assets/img/guides/retry-ability/v10/adds-two-items-fails.gif and /dev/null differ diff --git a/assets/img/guides/retry-ability/v10/adds-two-items-passes.gif b/assets/img/guides/retry-ability/v10/adds-two-items-passes.gif deleted file mode 100644 index 3220cba47d..0000000000 Binary files a/assets/img/guides/retry-ability/v10/adds-two-items-passes.gif and /dev/null differ diff --git a/assets/img/guides/retry-ability/v10/alternating-commands-assertions.png b/assets/img/guides/retry-ability/v10/alternating-commands-assertions.png deleted file mode 100644 index 3a31361e90..0000000000 Binary files a/assets/img/guides/retry-ability/v10/alternating-commands-assertions.png and /dev/null differ diff --git a/assets/img/guides/retry-ability/v10/combined-selectors.gif b/assets/img/guides/retry-ability/v10/combined-selectors.gif deleted file mode 100644 index 27090fae4e..0000000000 Binary files a/assets/img/guides/retry-ability/v10/combined-selectors.gif and /dev/null differ diff --git a/assets/img/guides/retry-ability/v10/command-assertions.png b/assets/img/guides/retry-ability/v10/command-assertions.png deleted file mode 100644 index c0ea8a4450..0000000000 Binary files a/assets/img/guides/retry-ability/v10/command-assertions.png and /dev/null differ diff --git a/assets/img/guides/retry-ability/v10/first-item-label.png b/assets/img/guides/retry-ability/v10/first-item-label.png deleted file mode 100644 index b8ca376c4e..0000000000 Binary files a/assets/img/guides/retry-ability/v10/first-item-label.png and /dev/null differ diff --git a/assets/img/guides/retry-ability/v10/retry-2-items.gif b/assets/img/guides/retry-ability/v10/retry-2-items.gif deleted file mode 100644 index 3f3efb951c..0000000000 Binary files a/assets/img/guides/retry-ability/v10/retry-2-items.gif and /dev/null differ diff --git a/assets/img/guides/retry-ability/v10/second-get-li.png b/assets/img/guides/retry-ability/v10/second-get-li.png deleted file mode 100644 index b18a21529a..0000000000 Binary files a/assets/img/guides/retry-ability/v10/second-get-li.png and /dev/null differ diff --git a/assets/img/guides/retry-ability/v10/second-item-label.png b/assets/img/guides/retry-ability/v10/second-item-label.png deleted file mode 100644 index f7c3477c99..0000000000 Binary files a/assets/img/guides/retry-ability/v10/second-item-label.png and /dev/null differ diff --git a/assets/img/guides/retry-ability/v10/two-items.png b/assets/img/guides/retry-ability/v10/two-items.png deleted file mode 100644 index bb30637a32..0000000000 Binary files a/assets/img/guides/retry-ability/v10/two-items.png and /dev/null differ diff --git a/content/_data/sidebar.json b/content/_data/sidebar.json index d32bf3a13d..1293df44a4 100644 --- a/content/_data/sidebar.json +++ b/content/_data/sidebar.json @@ -475,73 +475,89 @@ } ] }, - { - "title": "Events", - "slug": "events", - "children": [ - { - "title": "Catalog of Events", - "slug": "catalog-of-events" - } - ] - }, { "title": "Assertions", - "slug": "assertions", + "slug": "commands", "children": [ { - "title": "All Assertions", + "title": "Assertions Reference", "redirect": "/guides/references/assertions" + }, + { + "title": "and", + "slug": "and" + }, + { + "title": "should", + "slug": "should" } ] }, { - "title": "Commands", + "title": "Actions", "slug": "commands", "children": [ { - "title": "and", - "slug": "and" + "title": "Actionability Guide", + "redirect": "/guides/core-concepts/interacting-with-elements" }, { - "title": "as", - "slug": "as" + "title": "clear", + "slug": "clear" }, { - "title": "blur", - "slug": "blur" + "title": "click", + "slug": "click" }, { "title": "check", "slug": "check" }, { - "title": "children", - "slug": "children" + "title": "dblclick", + "slug": "dblclick" }, { - "title": "clear", - "slug": "clear" + "title": "rightclick", + "slug": "rightclick" }, { - "title": "clearCookie", - "slug": "clearcookie" + "title": "select", + "slug": "select" }, { - "title": "clearCookies", - "slug": "clearcookies" + "title": "selectFile", + "slug": "selectfile" }, { - "title": "clearLocalStorage", - "slug": "clearlocalstorage" + "title": "trigger", + "slug": "trigger" }, { - "title": "click", - "slug": "click" + "title": "type", + "slug": "type" }, { - "title": "clock", - "slug": "clock" + "title": "uncheck", + "slug": "uncheck" + } + ] + }, + { + "title": "Queries", + "slug": "commands", + "children": [ + { + "title": "Retry-ability Guide", + "redirect": "/guides/core-concepts/retry-ability" + }, + { + "title": "as", + "slug": "as" + }, + { + "title": "children", + "slug": "children" }, { "title": "closest", @@ -551,10 +567,6 @@ "title": "contains", "slug": "contains" }, - { - "title": "dblclick", - "slug": "dblclick" - }, { "title": "debug", "slug": "debug" @@ -563,22 +575,10 @@ "title": "document", "slug": "document" }, - { - "title": "each", - "slug": "each" - }, - { - "title": "end", - "slug": "end" - }, { "title": "eq", "slug": "eq" }, - { - "title": "exec", - "slug": "exec" - }, { "title": "filter", "slug": "filter" @@ -591,14 +591,6 @@ "title": "first", "slug": "first" }, - { - "title": "fixture", - "slug": "fixture" - }, - { - "title": "focus", - "slug": "focus" - }, { "title": "focused", "slug": "focused" @@ -607,30 +599,10 @@ "title": "get", "slug": "get" }, - { - "title": "getCookie", - "slug": "getcookie" - }, - { - "title": "getCookies", - "slug": "getcookies" - }, - { - "title": "go", - "slug": "go" - }, { "title": "hash", "slug": "hash" }, - { - "title": "hover", - "slug": "hover" - }, - { - "title": "intercept", - "slug": "intercept" - }, { "title": "invoke", "slug": "invoke" @@ -647,14 +619,6 @@ "title": "location", "slug": "location" }, - { - "title": "log", - "slug": "log" - }, - { - "title": "mount", - "slug": "mount" - }, { "title": "next", "slug": "next" @@ -671,10 +635,6 @@ "title": "not", "slug": "not" }, - { - "title": "origin", - "slug": "origin" - }, { "title": "parent", "slug": "parent" @@ -687,10 +647,6 @@ "title": "parentsUntil", "slug": "parentsuntil" }, - { - "title": "pause", - "slug": "pause" - }, { "title": "prev", "slug": "prev" @@ -703,6 +659,112 @@ "title": "prevUntil", "slug": "prevuntil" }, + { + "title": "root", + "slug": "root" + }, + { + "title": "shadow", + "slug": "shadow" + }, + { + "title": "siblings", + "slug": "siblings" + }, + { + "title": "title", + "slug": "title" + }, + { + "title": "url", + "slug": "url" + }, + { + "title": "window", + "slug": "window" + } + ] + }, + { + "title": "Other Commands", + "slug": "commands", + "children": [ + { + "title": "blur", + "slug": "blur" + }, + { + "title": "clearCookie", + "slug": "clearcookie" + }, + { + "title": "clearCookies", + "slug": "clearcookies" + }, + { + "title": "clearLocalStorage", + "slug": "clearlocalstorage" + }, + { + "title": "clock", + "slug": "clock" + }, + { + "title": "each", + "slug": "each" + }, + { + "title": "end", + "slug": "end" + }, + { + "title": "exec", + "slug": "exec" + }, + { + "title": "fixture", + "slug": "fixture" + }, + { + "title": "focus", + "slug": "focus" + }, + { + "title": "getCookie", + "slug": "getcookie" + }, + { + "title": "getCookies", + "slug": "getcookies" + }, + { + "title": "go", + "slug": "go" + }, + { + "title": "hover", + "slug": "hover" + }, + { + "title": "intercept", + "slug": "intercept" + }, + { + "title": "log", + "slug": "log" + }, + { + "title": "mount", + "slug": "mount" + }, + { + "title": "origin", + "slug": "origin" + }, + { + "title": "pause", + "slug": "pause" + }, { "title": "readFile", "slug": "readfile" @@ -715,14 +777,6 @@ "title": "request", "slug": "request" }, - { - "title": "rightclick", - "slug": "rightclick" - }, - { - "title": "root", - "slug": "root" - }, { "title": "screenshot", "slug": "screenshot" @@ -735,14 +789,6 @@ "title": "scrollTo", "slug": "scrollto" }, - { - "title": "select", - "slug": "select" - }, - { - "title": "selectFile", - "slug": "selectfile" - }, { "title": "session", "slug": "session" @@ -751,18 +797,6 @@ "title": "setCookie", "slug": "setcookie" }, - { - "title": "shadow", - "slug": "shadow" - }, - { - "title": "should", - "slug": "should" - }, - { - "title": "siblings", - "slug": "siblings" - }, { "title": "spread", "slug": "spread" @@ -791,26 +825,6 @@ "title": "tick", "slug": "tick" }, - { - "title": "title", - "slug": "title" - }, - { - "title": "trigger", - "slug": "trigger" - }, - { - "title": "type", - "slug": "type" - }, - { - "title": "uncheck", - "slug": "uncheck" - }, - { - "title": "url", - "slug": "url" - }, { "title": "viewport", "slug": "viewport" @@ -824,23 +838,29 @@ "slug": "wait" }, { - "title": "window", - "slug": "window" + "title": "wrap", + "slug": "wrap" }, { "title": "within", "slug": "within" }, - { - "title": "wrap", - "slug": "wrap" - }, { "title": "writeFile", "slug": "writefile" } ] }, + { + "title": "Events", + "slug": "events", + "children": [ + { + "title": "Catalog of Events", + "slug": "catalog-of-events" + } + ] + }, { "title": "Utilities", "slug": "utilities", @@ -880,9 +900,13 @@ "slug": "cypress-api", "children": [ { - "title": "Commands", + "title": "Custom Commands", "slug": "custom-commands" }, + { + "title": "Custom Queries", + "slug": "custom-queries" + }, { "title": "Cookies", "slug": "cookies" diff --git a/content/api/commands/and.md b/content/api/commands/and.md index ae1953a285..42cc46e27a 100644 --- a/content/api/commands/and.md +++ b/content/api/commands/and.md @@ -2,8 +2,8 @@ title: and --- -Create an assertion. Assertions are automatically retried until they pass or -time out. +Create an assertion. Assertions are automatically retried as part of the +previous command until they pass or time out. @@ -33,7 +33,9 @@ An alias of [`.should()`](/api/commands/should) ```javascript cy.get('.err').should('be.empty').and('be.hidden') // Assert '.err' is empty & hidden + cy.contains('Login').and('be.visible') // Assert el is visible + cy.wrap({ foo: 'bar' }) .should('have.property', 'foo') // Assert 'foo' property exists .and('eq', 'bar') // Assert 'foo' property is 'bar' @@ -42,7 +44,10 @@ cy.wrap({ foo: 'bar' }) ** Incorrect Usage** ```javascript -cy.and('eq', '42') // Should not be chained off 'cy' +cy.and('eq', '42') // Can not be chained off 'cy' + +cy.get('button').click().and('be.focused') // Should not be chained off +// action commands that may update the DOM ``` ### Arguments @@ -68,8 +73,9 @@ Whatever was passed to the function is what is yielded. ### Yields [](/guides/core-concepts/introduction-to-cypress#Subject-Management) -
  • In most cases, `.and()` yields the same subject it was given from the -previous command.
  • +- In most cases, `.and()` yields the same subject it was given. +- `.and()` is an assertion, and it is _safe_ to chain further commands that use + the subject. ```javascript cy.get('nav') // yields