Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update dependencies (install Docusaurus 3) #5601

Merged
merged 27 commits into from
Jan 16, 2024
Merged

update dependencies (install Docusaurus 3) #5601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
fb5bed7
update deps
Jan 9, 2024
1b4a73f
remove patches
Jan 9, 2024
ec49a79
cleanup migration guides
Jan 9, 2024
1abc688
fix typescript
Jan 9, 2024
3a1cc84
visit is now a named export
Jan 9, 2024
c20d77d
Merge branch 'main' into elevatebart/deps-2024-01-09
Jan 9, 2024
0091ef2
fix plugins
Jan 9, 2024
3df6710
removed a lot of things
Jan 9, 2024
535403e
fix parser for prettier
Jan 10, 2024
8d3204d
almost there
Jan 10, 2024
be1bc0d
try to make changes to the code displayed
Jan 10, 2024
e923d78
make sure the code samples follow js/ts
Jan 11, 2024
f1ba299
Now it works without a glisch
Jan 11, 2024
3bc4ece
Merge branch 'main' into elevatebart/deps-2024-01-09
Jan 11, 2024
4965af6
fix comments
Jan 11, 2024
1360de6
use proper types in plugins
Jan 11, 2024
bfc7daa
fix config
Jan 11, 2024
179b300
fix changelog broken links
Jan 11, 2024
da09357
a build that publishes
Jan 11, 2024
8f3d0f8
fix linter
Jan 11, 2024
3ab6f1e
docusaurus patches
Jan 11, 2024
6ac2724
remove all jsx/mdx render hacks
jaffrepaul Jan 11, 2024
f32243f
simplify weird args markdown bolding
jaffrepaul Jan 11, 2024
212ac80
lint
jaffrepaul Jan 11, 2024
fb643a2
small fixes
jaffrepaul Jan 11, 2024
06f8929
fix changelog cache ussues
Jan 12, 2024
dda52a9
another round of render hack fixes
jaffrepaul Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .prettierrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
"semi": false,
"singleQuote": true,
"printWidth": 80,
"proseWrap": "preserve"
}
"proseWrap": "preserve",
"trailingComma": "es5"
}
10 changes: 5 additions & 5 deletions docs/api/actions/check.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ This element must be an `<input>` with type `checkbox` or `radio`.

### Usage

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

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

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

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

### Arguments

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

Value of checkbox or radio that should be checked.

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

Values of checkboxes or radios that should be checked.

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

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

Expand Down
6 changes: 3 additions & 3 deletions docs/api/actions/clear.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ An alias for [`.type('{selectall}{backspace}')`](/api/commands/type)

### Usage

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

```javascript
cy.get('[type="text"]').clear() // Clear text input
cy.get('textarea').type('Hi!').clear() // Clear textarea
cy.focused().clear() // Clear focused input/textarea
```

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

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

### Arguments

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

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

Expand Down
32 changes: 16 additions & 16 deletions docs/api/actions/click.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ chain further commands that rely on the subject after `.click()`.

### Usage

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

```javascript
cy.get('.btn').click() // Click on button
cy.focused().click() // Click on el with focus
cy.contains('Welcome').click() // Click on first el containing 'Welcome'
```

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

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

### Arguments

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

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

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

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

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

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

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

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

| Option | Default | Description |
| ---------------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `altKey` | `false` | Activates the alt key (option key for Mac). Aliases: <code>optionKey</code>. |
| `altKey` | `false` | Activates the alt key (option key for Mac). Aliases: `optionKey`. |
| `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). |
| `ctrlKey` | `false` | Activates the control key. Aliases: <code>controlKey</code>. |
| `ctrlKey` | `false` | Activates the control key. Aliases: `controlKey`. |
| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) |
| `force` | `false` | Forces the action, disables [waiting for actionability](#Assertions) |
| `metaKey` | `false` | Activates the meta key (Windows key or command key for Mac). Aliases: <code>commandKey</code>, <code>cmdKey</code>. |
| `metaKey` | `false` | Activates the meta key (Windows key or command key for Mac). Aliases: `commandKey`, `cmdKey`. |
| `multiple` | `false` | Serially click multiple elements |
| `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 |
| `shiftKey` | `false` | Activates the shift key. |
Expand Down Expand Up @@ -163,12 +163,12 @@ offers options to hold down keys across multiple commands. See

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

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

#### Shift click

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

#### Mousedown cancellation will not cause focus

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

## Rules
Expand Down
30 changes: 15 additions & 15 deletions docs/api/actions/dblclick.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ chain further commands that rely on the subject after `.dblclick()`.

### Usage

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

```javascript
cy.get('button').dblclick() // Double click on button
cy.focused().dblclick() // Double click on el with focus
cy.contains('Welcome').dblclick() // Double click on first el containing 'Welcome'
```

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

```javascript
cy.dblclick('button') // Errors, cannot be chained off 'cy'
Expand All @@ -38,7 +38,7 @@ cy.window().dblclick() // Errors, 'window' does not yield DOM element

### Arguments

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

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

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

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

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

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

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

Pass in an options object to change the default behavior of `.dblclick()`.

| Option | Default | Description |
| ---------------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `altKey` | `false` | Activates the alt key (option key for Mac). Aliases: <code>optionKey</code>. |
| `altKey` | `false` | Activates the alt key (option key for Mac). Aliases: `optionKey`. |
| `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). |
| `ctrlKey` | `false` | Activates the control key. Aliases: <code>controlKey</code>. |
| `ctrlKey` | `false` | Activates the control key. Aliases: `controlKey`. |
| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) |
| `force` | `false` | Forces the action, disables [waiting for actionability](#Assertions) |
| `metaKey` | `false` | Activates the meta key (Windows key or command key for Mac). Aliases: <code>commandKey</code>, <code>cmdKey</code>. |
| `metaKey` | `false` | Activates the meta key (Windows key or command key for Mac). Aliases: `commandKey`, `cmdKey`. |
| `multiple` | `true` | Serially click multiple elements |
| `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 |
| `shiftKey` | `false` | Activates the shift key. |
Expand Down Expand Up @@ -164,12 +164,12 @@ offers options to hold down keys across multiple commands. See

The following modifiers can be combined with `.dblclick()`.

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

##### Alt click

Expand Down
Loading