Skip to content

Commit 6f2057d

Browse files
allenzhou101allenzhou101
authored
Merge branch 'main' into adding-descope-testing-strat-guide
2 parents 7d4e71d + d77b25a commit 6f2057d

File tree

456 files changed

+14390
-18894
lines changed

Some content is hidden

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

456 files changed

+14390
-18894
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/PULL_REQUEST_TEMPLATE/plugin_template.md

-13
This file was deleted.

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

-32
This file was deleted.

‎.node-version

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

‎.prettierrc

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
"semi": false,
33
"singleQuote": true,
44
"printWidth": 80,
5-
"proseWrap": "preserve"
6-
}
5+
"proseWrap": "preserve",
6+
"trailingComma": "es5"
7+
}

‎CONTRIBUTING.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,19 @@ Thanks for taking the time to contribute! :smile:
55
## Table of Contents
66

77
- [Contributing to Cypress Documentation](#contributing-to-cypress-documentation)
8+
- [Table of Contents](#table-of-contents)
89
- [Code of Conduct](#code-of-conduct)
910
- [Writing Documentation](#writing-documentation)
10-
- [Admonitions](#admonitions)
11-
- [Images](#images)
12-
- [Videos](#videos)
13-
- [Icons](#icons)
11+
- [VSCode MDX Extension](#vscode-mdx-extension)
12+
- [Admonitions](#admonitions)
13+
- [Images](#images)
14+
- [Videos](#videos)
15+
- [Icons](#icons)
1416
- [Partials](#partials)
1517
- [Adding Plugins](#adding-plugins)
1618
- [Adding Pages](#adding-pages)
19+
- [Patches](#patches)
20+
- [@docusaurus/mdx-loader patch](#docusaurusmdx-loader-patch)
1721
- [Writing the Changelog](#writing-the-changelog)
1822
- [Categories](#categories)
1923
- [Committing Code](#committing-code)
@@ -41,7 +45,7 @@ fork) of this repository under your personal account.
4145
**Clone your forked repository**
4246

4347
```shell
44-
git clone git@github.com:<your username>/cypress-documentation.git
48+
git clone https://github.com/<your username>/cypress-documentation.git
4549
cd cypress-documentation
4650
```
4751

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Cloud & FAQ found at https://docs.cypress.io.
1212

1313
[![Netlify Status](https://api.netlify.com/api/v1/badges/dbf22ada-b50c-49b0-a933-bf02e87d25d1/deploy-status)](https://app.netlify.com/sites/cypress-docs/deploys)
1414

15-
Our docs are built using [Docusaurus 2](https://docusaurus.io/).
15+
Our docs are built using [Docusaurus](https://docusaurus.io/).
1616

1717
### Installation
1818

‎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

+5-5
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ This element must be an `<input>` with type `checkbox` or `radio`.
2727

2828
### Usage
2929

30-
**<Icon name="check-circle" color="green" /> Correct Usage**
30+
<Icon name="check-circle" color="green" /> **Correct Usage**
3131

3232
```javascript
3333
cy.get('[type="checkbox"]').check() // Check checkbox element
3434
cy.get('[type="radio"]').first().check() // Check first radio element
3535
```
3636

37-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
37+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
3838

3939
```javascript
4040
cy.check('[type="checkbox"]') // Errors, cannot be chained off 'cy'
@@ -43,15 +43,15 @@ cy.get('p:first').check() // Errors, '.get()' does not yield checkbox or radio
4343

4444
### Arguments
4545

46-
**<Icon name="angle-right" /> value** **_(String)_**
46+
<Icon name="angle-right" /> **value _(String)_**
4747

4848
Value of checkbox or radio that should be checked.
4949

50-
**<Icon name="angle-right" /> values** **_(Array)_**
50+
<Icon name="angle-right" /> **values _(Array)_**
5151

5252
Values of checkboxes or radios that should be checked.
5353

54-
**<Icon name="angle-right" /> options** **_(Object)_**
54+
<Icon name="angle-right" /> **options _(Object)_**
5555

5656
Pass in an options object to change the default behavior of `.check()`.
5757

‎docs/api/actions/clear.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ An alias for [`.type('{selectall}{backspace}')`](/api/commands/type)
2323

2424
### Usage
2525

26-
**<Icon name="check-circle" color="green" /> Correct Usage**
26+
<Icon name="check-circle" color="green" /> **Correct Usage**
2727

2828
```javascript
2929
cy.get('[type="text"]').clear() // Clear text input
3030
cy.get('textarea').type('Hi!').clear() // Clear textarea
3131
cy.focused().clear() // Clear focused input/textarea
3232
```
3333

34-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
34+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
3535

3636
```javascript
3737
cy.clear() // Errors, cannot be chained off 'cy'
@@ -41,7 +41,7 @@ cy.clock().clear() // Errors, 'clock' does not yield DOM elements
4141

4242
### Arguments
4343

44-
**<Icon name="angle-right" /> options** **_(Object)_**
44+
<Icon name="angle-right" /> **options _(Object)_**
4545

4646
Pass in an options object to change the default behavior of `.clear()`.
4747

‎docs/api/actions/click.mdx

+16-16
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ chain further commands that rely on the subject after `.click()`.
2121

2222
### Usage
2323

24-
**<Icon name="check-circle" color="green" /> Correct Usage**
24+
<Icon name="check-circle" color="green" /> **Correct Usage**
2525

2626
```javascript
2727
cy.get('.btn').click() // Click on button
2828
cy.focused().click() // Click on el with focus
2929
cy.contains('Welcome').click() // Click on first el containing 'Welcome'
3030
```
3131

32-
**<Icon name="exclamation-triangle" color="red" /> Incorrect Usage**
32+
<Icon name="exclamation-triangle" color="red" /> **Incorrect Usage**
3333

3434
```javascript
3535
cy.click('.btn') // Errors, cannot be chained off 'cy'
@@ -38,7 +38,7 @@ cy.window().click() // Errors, 'window' does not yield DOM element
3838

3939
### Arguments
4040

41-
**<Icon name="angle-right" /> position** **_(String)_**
41+
<Icon name="angle-right" /> **position _(String)_**
4242

4343
The position where the click should be issued. The `center` position is the
4444
default position. Valid positions are `topLeft`, `top`, `topRight`, `left`,
@@ -49,26 +49,26 @@ default position. Valid positions are `topLeft`, `top`, `topRight`, `left`,
4949
alt="cypress-command-positions-diagram"
5050
/>
5151

52-
**<Icon name="angle-right" /> x** **_(Number)_**
52+
<Icon name="angle-right" /> **x _(Number)_**
5353

5454
The distance in pixels from the element's left to issue the click.
5555

56-
**<Icon name="angle-right" /> y** **_(Number)_**
56+
<Icon name="angle-right" /> **y _(Number)_**
5757

5858
The distance in pixels from the element's top to issue the click.
5959

60-
**<Icon name="angle-right" /> options** **_(Object)_**
60+
<Icon name="angle-right" /> **options _(Object)_**
6161

6262
Pass in an options object to change the default behavior of `.click()`.
6363

6464
| Option | Default | Description |
6565
| ---------------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
66-
| `altKey` | `false` | Activates the alt key (option key for Mac). Aliases: <code>optionKey</code>. |
66+
| `altKey` | `false` | Activates the alt key (option key for Mac). Aliases: `optionKey`. |
6767
| `animationDistanceThreshold` | [`animationDistanceThreshold`](/guides/references/configuration#Actionability) | The distance in pixels an element must exceed over time to be [considered animating](/guides/core-concepts/interacting-with-elements#Animations). |
68-
| `ctrlKey` | `false` | Activates the control key. Aliases: <code>controlKey</code>. |
68+
| `ctrlKey` | `false` | Activates the control key. Aliases: `controlKey`. |
6969
| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) |
7070
| `force` | `false` | Forces the action, disables [waiting for actionability](#Assertions) |
71-
| `metaKey` | `false` | Activates the meta key (Windows key or command key for Mac). Aliases: <code>commandKey</code>, <code>cmdKey</code>. |
71+
| `metaKey` | `false` | Activates the meta key (Windows key or command key for Mac). Aliases: `commandKey`, `cmdKey`. |
7272
| `multiple` | `false` | Serially click multiple elements |
7373
| `scrollBehavior` | [`scrollBehavior`](/guides/references/configuration#Actionability) | Viewport position to where an element [should be scrolled](/guides/core-concepts/interacting-with-elements#Scrolling) before executing the command |
7474
| `shiftKey` | `false` | Activates the shift key. |
@@ -163,12 +163,12 @@ offers options to hold down keys across multiple commands. See
163163

164164
The following keys can be combined with `.click()` through the `options`.
165165

166-
| Option | Notes |
167-
| ---------- | ------------------------------------------------------------------------------------------------------------------- |
168-
| `altKey` | Activates the alt key (option key for Mac). Aliases: <code>optionKey</code>. |
169-
| `ctrlKey` | Activates the control key. Aliases: <code>controlKey</code>. |
170-
| `metaKey` | Activates the meta key (Windows key or command key for Mac). Aliases: <code>commandKey</code>, <code>cmdKey</code>. |
171-
| `shiftKey` | Activates the shift key. |
166+
| Option | Notes |
167+
| ---------- | --------------------------------------------------------------------------------------------- |
168+
| `altKey` | Activates the alt key (option key for Mac). Aliases: `optionKey`. |
169+
| `ctrlKey` | Activates the control key. Aliases: `controlKey`. |
170+
| `metaKey` | Activates the meta key (Windows key or command key for Mac). Aliases: `commandKey`, `cmdKey`. |
171+
| `shiftKey` | Activates the shift key. |
172172

173173
#### Shift click
174174

@@ -204,7 +204,7 @@ found the window is given focus instead (which matches real browser behavior).
204204

205205
#### Mousedown cancellation will not cause focus
206206

207-
If the mousedown event has its default action prevented (`e.preventDefault()`)
207+
If the mousedown event has its default action prevented ( `e.preventDefault()` )
208208
then the element will not receive focus as per the spec.
209209

210210
## Rules

0 commit comments

Comments
 (0)