Skip to content

docs: add escape key to supported key.press() named keys #6279

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

Merged
merged 3 commits into from
Sep 23, 2025
Merged

docs: add escape key to supported key.press() named keys #6279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a69fa8
docs: add escape key
cacieprins Sep 22, 2025
8aa0b3e
reorder history for cy.press
cacieprins Sep 22, 2025
ea941e1
Merge branch 'release/15.3.0' into docs/cy-press-esc
jennifer-shehane Sep 23, 2025
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
12 changes: 7 additions & 5 deletions docs/api/commands/press.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,11 @@ The key to press. Values for non single character keys are available on [`Cypres
| Letters | `"a"` through `"z"`, `"A"` through `"Z"` |
| Numbers | `"0"`, `"1"`, `"2"`, `"3"`, `"4"`, `"5"`, `"6"`, `"7"`, `"8"`, `"9"` |
| Special Characters | `"!"`, `"@"`, `"#"`, `'+'`, `"€"`, `"é"`, etc. |
| `Cypress.Keyboard.Keys.UP` | `"ArrowUp"` |
| `Cypress.Keyboard.Keys.DOWN` | `"ArrowDown"` |
| `Cypress.Keyboard.Keys.LEFT` | `"ArrowLeft"` |
| `Cypress.Keyboard.Keys.RIGHT` | `"ArrowRight"` |
| `Cypress.Keyboard.Keys.UP` | `"ArrowUp"` |
| `Cypress.Keyboard.Keys.ESC` | `"Escape"` |
| `Cypress.Keyboard.Keys.END` | `"End"` |
| `Cypress.Keyboard.Keys.HOME` | `"Home"` |
| `Cypress.Keyboard.Keys.PAGEDOWN` | `"PageDown"` |
Expand Down Expand Up @@ -167,10 +168,11 @@ If your application prevents the default behavior of the `beforeunload` event, t

## History

| Version | Changes |
| ------------------------------------------ | ----------------------------------------------------------------------------------- |
| [15.1.0](/app/references/changelog#15-1-0) | Expanded support to include named keys and single+multi-codepoint UTF-8 characters. |
| [14.3.0](/app/references/changelog#14-3-0) | Added the `.press()` command |
| Version | Changes |
| ----------------------------------- | ----------------------------------------------------------------------------------- |
| [15.3.0](/app/references/changelog) | Added support for `{esc}` key. |
| [15.1.0](/app/references/changelog) | Expanded support to include named keys and single+multi-codepoint UTF-8 characters. |
| [14.3.0](/app/references/changelog) | Added the `.press()` command |

## See also

Expand Down
23 changes: 20 additions & 3 deletions docs/api/cypress-api/keyboard-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,26 @@ The key available for `cy.press()`.

The following keys are supported:

| Reference | Value |
| --------------------------- | ------- |
| `Cypress.Keyboard.Keys.TAB` | `"Tab"` |
| Reference | Value |
| --------------------------------- | -------------------------------------------------------------------- |
| Letters | `"a"` through `"z"`, `"A"` through `"Z"` |
| Numbers | `"0"`, `"1"`, `"2"`, `"3"`, `"4"`, `"5"`, `"6"`, `"7"`, `"8"`, `"9"` |
| Special Characters | `"!"`, `"@"`, `"#"`, `'+'`, `"€"`, `"é"`, etc. |
| `Cypress.Keyboard.Keys.UP` | `"ArrowUp"` |
| `Cypress.Keyboard.Keys.DOWN` | `"ArrowDown"` |
| `Cypress.Keyboard.Keys.LEFT` | `"ArrowLeft"` |
| `Cypress.Keyboard.Keys.RIGHT` | `"ArrowRight"` |
| `Cypress.Keyboard.Keys.ESC` | `"Escape"` |
| `Cypress.Keyboard.Keys.END` | `"End"` |
| `Cypress.Keyboard.Keys.HOME` | `"Home"` |
| `Cypress.Keyboard.Keys.PAGEDOWN` | `"PageDown"` |
| `Cypress.Keyboard.Keys.PAGEUP` | `"PageUp"` |
| `Cypress.Keyboard.Keys.ENTER` | `"Enter"` |
| `Cypress.Keyboard.Keys.TAB` | `"Tab"` |
| `Cypress.Keyboard.Keys.BACKSPACE` | `"Backspace"` |
| `Cypress.Keyboard.Keys.DELETE` | `"Delete"` |
| `Cypress.Keyboard.Keys.INSERT` | `"Insert"` |
| `Cypress.Keyboard.Keys.SPACE` | `"Space"` |

### defaults Arguments

Expand Down