Skip to content

Commit ffe32d5

Browse files
MandroideMandroide
authored
Merge branch 'main' into docs-api-commands-fixture-global-this
2 parents ab5496b + ecc6db9 commit ffe32d5

File tree

422 files changed

+9140
-7429
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

422 files changed

+9140
-7429
lines changed

‎.circleci/config.yml

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
version: 2.1
22

3-
orbs:
4-
cypress: cypress-io/[email protected]
5-
63
executors:
74
node-executor:
5+
resource_class: medium+
86
docker:
9-
- image: cimg/node:16.15.1
7+
- image: cimg/node:18.15.0
108
with-chrome-and-firefox:
119
resource_class: medium+
1210
docker:
13-
- image: 'cypress/browsers:node16.13.2-chrome97-ff96'
11+
- image: 'cypress/browsers:node18.12.0-chrome106-ff106'
1412

1513
commands:
1614
docs-build:

‎.github/workflows/add_issue_to_triage_board.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: 'Add issue/PR to Triage Board'
2+
on:
3+
issues:
4+
types:
5+
- opened
6+
pull_request_target:
7+
types:
8+
- opened
9+
jobs:
10+
add-to-triage-project-board:
11+
uses: cypress-io/cypress/.github/workflows/triage_add_to_project.yml@develop
12+
secrets: inherit

‎.github/workflows/triage_handle_issue_comment.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name: 'Handle Comment Workflow'
2+
on:
3+
issue_comment:
4+
types:
5+
- created
6+
jobs:
7+
closed-issue-comment:
8+
uses: cypress-io/cypress/.github/workflows/triage_handle_new_comments.yml@develop
9+
secrets: inherit

‎.node-version

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
16
1+
18.17.1

‎.prettierrc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
"semi": false,
33
"singleQuote": true,
44
"printWidth": 80,
5-
"proseWrap": "always"
5+
"proseWrap": "preserve"
66
}

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Cypress Documentation [![Cypress Cloud](https://img.shields.io/badge/cypress-dashboard-brightgreen.svg)](https://cloud.cypress.io/#/projects/ma3dkn/runs) [![first-timers-only](http://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://github.com/cypress-io/cypress-documentation/labels/first-timers-only)
1+
# Cypress Documentation [![Discord chat](https://img.shields.io/badge/chat-on%20Discord-brightgreen)](https://on.cypress.io/discord) [![first-timers-only](http://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://github.com/cypress-io/cypress-documentation/labels/first-timers-only)
22

33
The code for Cypress Documentation including Guides, API, Examples, Cypress
44
Cloud & FAQ found at https://docs.cypress.io.

‎docs/api/actions/actionability-guide.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Actionability Guide
33
sidebar_position: 10
4+
sidebar_class_name: sidebar-guide-ref
45
---
56

67
import { Redirect } from '@docusaurus/router'

‎docs/api/actions/check.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Pass in an options object to change the default behavior of `.check()`.
6464
| `timeout` | [`defaultCommandTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `.check()` to resolve before [timing out](#Timeouts) |
6565
| `waitForAnimations` | [`waitForAnimations`](/guides/references/configuration#Actionability) | Whether to wait for elements to [finish animating](/guides/core-concepts/interacting-with-elements#Animations) before executing the command. |
6666

67-
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management)
67+
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management) {#Yields}
6868

6969
- `.check()` yields the same subject it was given.
7070
- It is [unsafe](/guides/core-concepts/retry-ability#Only-queries-are-retried)
@@ -168,19 +168,19 @@ cy.get('#pick-fruit :checked').should('be.checked').and('have.value', 'apple')
168168

169169
## Rules
170170

171-
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands)
171+
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands) {#Requirements}
172172

173173
- `.check()` requires being chained off a command that yields DOM element(s).
174174
- `.check()` requires the element to have type `checkbox` or `radio`.
175175

176-
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions)
176+
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions) {#Assertions}
177177

178178
- `.check()` will automatically wait for the element to reach an
179179
[actionable state](/guides/core-concepts/interacting-with-elements).
180180
- `.check()` will automatically [retry](/guides/core-concepts/retry-ability)
181181
until all chained assertions have passed.
182182

183-
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts)
183+
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts) {#Timeouts}
184184

185185
- `.check()` can time out waiting for the element to reach an
186186
[actionable state](/guides/core-concepts/interacting-with-elements).

‎docs/api/actions/clear.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Pass in an options object to change the default behavior of `.clear()`.
5454
| `timeout` | [`defaultCommandTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `.clear()` to resolve before [timing out](#Timeouts) |
5555
| `waitForAnimations` | [`waitForAnimations`](/guides/references/configuration#Actionability) | Whether to wait for elements to [finish animating](/guides/core-concepts/interacting-with-elements#Animations) before executing the command. |
5656

57-
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management)
57+
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management) {#Yields}
5858

5959
- `.clear()` yields the same subject it was given.
6060
- It is [unsafe](/guides/core-concepts/retry-ability#Only-queries-are-retried)
@@ -88,19 +88,19 @@ Please read the [`.type()`](/api/commands/type) documentation for more details.
8888

8989
## Rules
9090

91-
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands)
91+
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands) {#Requirements}
9292

9393
- `.clear()` requires being chained off a command that yields DOM element(s).
9494
- `.clear()` requires the element to be an `input` or `textarea`.
9595

96-
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions)
96+
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions) {#Assertions}
9797

9898
- `.clear()` will automatically wait for the element to reach an
9999
[actionable state](/guides/core-concepts/interacting-with-elements)
100100
- `.clear()` will automatically [retry](/guides/core-concepts/retry-ability)
101101
until all chained assertions have passed
102102

103-
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts)
103+
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts) {#Timeouts}
104104

105105
- `.clear()` can time out waiting for the element to reach an
106106
[actionable state](/guides/core-concepts/interacting-with-elements).

‎docs/api/actions/click.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Pass in an options object to change the default behavior of `.click()`.
7575
| `timeout` | [`defaultCommandTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `.click()` to resolve before [timing out](#Timeouts) |
7676
| `waitForAnimations` | [`waitForAnimations`](/guides/references/configuration#Actionability) | Whether to wait for elements to [finish animating](/guides/core-concepts/interacting-with-elements#Animations) before executing the command. |
7777

78-
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management)
78+
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management) {#Yields}
7979

8080
- `.click()` yields the same subject it was given.
8181
- It is [unsafe](/guides/core-concepts/retry-ability#Only-queries-are-retried)
@@ -209,18 +209,18 @@ then the element will not receive focus as per the spec.
209209

210210
## Rules
211211

212-
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands)
212+
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands) {#Requirements}
213213

214214
- `.click()` requires being chained off a command that yields DOM element(s).
215215

216-
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions)
216+
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions) {#Assertions}
217217

218218
- `.click()` will automatically wait for the element to reach an
219219
[actionable state](/guides/core-concepts/interacting-with-elements).
220220
- `.click()`will automatically [retry](/guides/core-concepts/retry-ability)
221221
until all chained assertions have passed.
222222

223-
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts)
223+
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts) {#Timeouts}
224224

225225
- `.click()` can time out waiting for the element to reach an
226226
[actionable state](/guides/core-concepts/interacting-with-elements).

‎docs/api/actions/dblclick.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Pass in an options object to change the default behavior of `.dblclick()`.
7575
| `timeout` | [`defaultCommandTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `.dblclick()` to resolve before [timing out](#Timeouts) |
7676
| `waitForAnimations` | [`waitForAnimations`](/guides/references/configuration#Actionability) | Whether to wait for elements to [finish animating](/guides/core-concepts/interacting-with-elements#Animations) before executing the command. |
7777

78-
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management)
78+
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management) {#Yields}
7979

8080
- `.dblclick()` yields the same subject it was given.
8181
- It is [unsafe](/guides/core-concepts/retry-ability#Only-queries-are-retried)
@@ -191,18 +191,18 @@ cy.get('li:first').dblclick({
191191

192192
## Rules
193193

194-
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands)
194+
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands) {#Requirements}
195195

196196
- `.dblclick()` requires being chained off a command that yields DOM element(s).
197197

198-
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions)
198+
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions) {#Assertions}
199199

200200
- `.dblclick()` will automatically wait for the element to reach an
201201
[actionable state](/guides/core-concepts/interacting-with-elements).
202202
- `.dblclick()` will automatically [retry](/guides/core-concepts/retry-ability)
203203
until all chained assertions have passed.
204204

205-
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts)
205+
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts) {#Timeouts}
206206

207207
- `.dblclick()` can time out waiting for the element to reach an
208208
[actionable state](/guides/core-concepts/interacting-with-elements).

‎docs/api/actions/rightclick.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Pass in an options object to change the default behavior of `.rightclick()`.
8383
| `timeout` | [`defaultCommandTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `.rightclick()` to resolve before [timing out](#Timeouts) |
8484
| `waitForAnimations` | [`waitForAnimations`](/guides/references/configuration#Actionability) | Whether to wait for elements to [finish animating](/guides/core-concepts/interacting-with-elements#Animations) before executing the command. |
8585

86-
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management)
86+
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management) {#Yields}
8787

8888
- `.rightclick()` yields the same subject it was given.
8989
- It is [unsafe](/guides/core-concepts/retry-ability#Only-queries-are-retried)
@@ -198,20 +198,20 @@ cy.get('.menu-item').rightclick({
198198

199199
## Rules
200200

201-
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands)
201+
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands) {#Requirements}
202202

203203
- `.rightclick()` requires being chained off a command that yields DOM
204204
element(s).
205205

206-
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions)
206+
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions) {#Assertions}
207207

208208
- `.rightclick()` will automatically wait for the element to reach an
209209
[actionable state](/guides/core-concepts/interacting-with-elements).
210210
- `.rightclick()` will automatically
211211
[retry](/guides/core-concepts/retry-ability) until all chained assertions have
212212
passed.
213213

214-
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts)
214+
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts) {#Timeouts}
215215

216216
- `.rightclick()` can time out waiting for the element to reach an
217217
[actionable state](/guides/core-concepts/interacting-with-elements).

‎docs/api/actions/scrollintoview.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Pass in an options object to change the default behavior of `.scrollIntoView()`.
4444
| `offset` | `{top: 0, left: 0}` | Amount to scroll after the element has been scrolled into view |
4545
| `timeout` | [`defaultCommandTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `.scrollIntoView()` to resolve before [timing out](#Timeouts) |
4646

47-
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management)
47+
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management) {#Yields}
4848

4949
- `.scrollIntoView()` yields the same subject it was given.
5050
- It is [unsafe](/guides/core-concepts/retry-ability#Only-queries-are-retried)
@@ -92,17 +92,17 @@ or
9292

9393
## Rules
9494

95-
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands)
95+
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands) {#Requirements}
9696

9797
- `.scrollIntoView()` requires being chained off a command that yields DOM
9898
element(s).
9999

100-
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions)
100+
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions) {#Assertions}
101101

102102
- `.scrollIntoView()` will automatically wait for assertions you have chained to
103103
pass
104104

105-
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts)
105+
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts) {#Timeouts}
106106

107107
- `.scrollIntoView()` can time out waiting for assertions you've added to pass.
108108

‎docs/api/actions/scrollto.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Pass in an options object to change the default behavior of `cy.scrollTo()`.
7474
| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) |
7575
| `timeout` | [`defaultCommandTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `.scrollTo()` to resolve before [timing out](#Timeouts) |
7676

77-
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management)
77+
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management) {#Yields}
7878

7979
- `.scrollTo()` yields the same subject it was given.
8080
- It is [unsafe](/guides/core-concepts/retry-ability#Only-queries-are-retried)
@@ -183,12 +183,12 @@ or
183183

184184
## Rules
185185

186-
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands)
186+
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands) {#Requirements}
187187

188188
- `.scrollTo()` requires being chained off a command that yields DOM element(s).
189189
- `.scrollTo()` requires the element to be scrollable.
190190

191-
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts)
191+
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts) {#Timeouts}
192192

193193
- `.scrollTo()` can time out waiting for assertions you've added to pass.
194194

‎docs/api/actions/select.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Pass in an options object to change the default behavior of `.select()`.
5353
| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) |
5454
| `timeout` | [`defaultCommandTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `.select()` to resolve before [timing out](#Timeouts) |
5555

56-
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management)
56+
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management) {#Yields}
5757

5858
- `.select()` yields the same subject it was given.
5959
- It is [unsafe](/guides/core-concepts/retry-ability#Only-queries-are-retried)
@@ -253,19 +253,19 @@ disabled `<optgroup>`. See
253253

254254
## Rules
255255

256-
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands)
256+
### Requirements [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Chains-of-Commands) {#Requirements}
257257

258258
- `.select()` requires being chained off a command that yields DOM element(s).
259259
- `.select()` requires the element to be a `select`.
260260

261-
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions)
261+
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions) {#Assertions}
262262

263263
- `.select()` will automatically wait for the element to reach an
264264
[actionable state](/guides/core-concepts/interacting-with-elements).
265265
- `.select()` will automatically [retry](/guides/core-concepts/retry-ability)
266266
until all chained assertions have passed.
267267

268-
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts)
268+
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts) {#Timeouts}
269269

270270
- `.select()` can time out waiting for the element to reach an
271271
[actionable state](/guides/core-concepts/interacting-with-elements).

0 commit comments

Comments
 (0)