{ "doc": { "id": "api/cypress-api/keyboard-api", "title": "Cypress.Keyboard | Cypress Documentation", "description": "Set the default values for how the .type() command is executed in Cypress.", "section": "api", "source_path": "/llm/markdown/api/cypress-api/keyboard-api.md", "version": "524ff5211e60b5d53e55d6ad976d83966f66e7cd", "updated_at": "2026-04-30T14:20:05.396Z", "headings": [ { "id": "api/cypress-api/keyboard-api#cypress-keyboard", "text": "Cypress.Keyboard", "level": 1 }, { "id": "api/cypress-api/keyboard-api#syntax", "text": "Syntax", "level": 2 }, { "id": "api/cypress-api/keyboard-api#keys-arguments", "text": "Keys Arguments", "level": 3 }, { "id": "api/cypress-api/keyboard-api#defaults-arguments", "text": "defaults Arguments", "level": 3 }, { "id": "api/cypress-api/keyboard-api#examples", "text": "Examples", "level": 2 }, { "id": "api/cypress-api/keyboard-api#press-tab-key", "text": "Press tab key", "level": 3 }, { "id": "api/cypress-api/keyboard-api#slow-down-typing-by-increasing-the-keystroke-delay", "text": "Slow down typing by increasing the keystroke delay", "level": 3 }, { "id": "api/cypress-api/keyboard-api#remove-the-keystroke-delay", "text": "Remove the keystroke delay", "level": 3 }, { "id": "api/cypress-api/keyboard-api#notes", "text": "Notes", "level": 2 }, { "id": "api/cypress-api/keyboard-api#where-to-put-keyboard-configuration", "text": "Where to put Keyboard configuration", "level": 3 }, { "id": "api/cypress-api/keyboard-api#set-the-keystroke-delay-in-test-configuration", "text": "Set the keystroke delay in test configuration", "level": 3 }, { "id": "api/cypress-api/keyboard-api#see-also", "text": "See also", "level": 2 } ] }, "content": { "type": "root", "children": [ { "type": "heading", "depth": 1, "children": [ { "type": "text", "value": "Cypress.Keyboard" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The Keyboard API allows you to access available `Keys` for use with " }, { "type": "link", "title": null, "url": "/llm/markdown/api/commands/press.md", "children": [ { "type": "text", "value": "`cy.press()`" } ] }, { "type": "text", "value": " or to set the default values for how the " }, { "type": "link", "title": null, "url": "/llm/markdown/api/commands/type.md", "children": [ { "type": "text", "value": ".type()" } ] }, { "type": "text", "value": " command is executed." } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Syntax" } ] }, { "type": "code", "lang": null, "meta": null, "value": "Cypress.Keyboard.Keys(key)Cypress.Keyboard.defaults(options)" }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Keys Arguments" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "key (String)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The key available for `cy.press()`." } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The following keys are supported:" } ] }, { "type": "table", "align": [ null, null ], "children": [ { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "Reference" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Value" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "Letters" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"a\"` through `\"z\"`, `\"A\"` through `\"Z\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "Numbers" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"0\"`, `\"1\"`, `\"2\"`, `\"3\"`, `\"4\"`, `\"5\"`, `\"6\"`, `\"7\"`, `\"8\"`, `\"9\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "Special Characters" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"!\"`, `\"@\"`, `\"#\"`, `'+'`, `\"€\"`, `\"é\"`, etc." } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.UP`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"ArrowUp\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.DOWN`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"ArrowDown\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.LEFT`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"ArrowLeft\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.RIGHT`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"ArrowRight\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.ESC`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"Escape\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.END`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"End\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.HOME`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"Home\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.PAGEDOWN`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"PageDown\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.PAGEUP`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"PageUp\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.ENTER`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"Enter\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.TAB`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"Tab\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.BACKSPACE`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"Backspace\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.DELETE`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"Delete\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.INSERT`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"Insert\"`" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`Cypress.Keyboard.Keys.SPACE`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`\"Space\"`" } ] } ] } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "defaults Arguments" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "options (Object)" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "An object containing the following:" } ] }, { "type": "table", "align": [ null, null, null ], "children": [ { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "Option" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Default" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "Description" } ] } ] }, { "type": "tableRow", "children": [ { "type": "tableCell", "children": [ { "type": "text", "value": "`keystrokeDelay`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "`10`" } ] }, { "type": "tableCell", "children": [ { "type": "text", "value": "The delay, in milliseconds, between keystrokes while typing with " }, { "type": "link", "title": null, "url": "/llm/markdown/api/commands/type.md", "children": [ { "type": "text", "value": ".type()" } ] }, { "type": "text", "value": ". Set to `0` to remove the delay. Must be a non-negative number." } ] } ] } ] }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Examples" } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Press tab key" } ] }, { "type": "code", "lang": null, "meta": null, "value": "cy.press(Cypress.Keyboard.Keys.TAB)cy.get('input.second').should('have.focus')" }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Slow down typing by increasing the keystroke delay" } ] }, { "type": "code", "lang": null, "meta": null, "value": "Cypress.Keyboard.defaults({ keystrokeDelay: 20,})" }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Remove the keystroke delay" } ] }, { "type": "code", "lang": null, "meta": null, "value": "Cypress.Keyboard.defaults({ keystrokeDelay: 0,})" }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "Notes" } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Where to put Keyboard configuration" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "A great place to put this configuration is in the " }, { "type": "link", "title": null, "url": "/llm/markdown/app/core-concepts/writing-and-organizing-tests.md#Support-file", "children": [ { "type": "text", "value": "supportFile" } ] }, { "type": "text", "value": ", since it is loaded before any test files are evaluated." } ] }, { "type": "heading", "depth": 3, "children": [ { "type": "text", "value": "Set the keystroke delay in test configuration" } ] }, { "type": "paragraph", "children": [ { "type": "text", "value": "The keystroke delay can also be set via " }, { "type": "link", "title": null, "url": "/llm/markdown/app/core-concepts/writing-and-organizing-tests.md#Test-Configuration", "children": [ { "type": "text", "value": "test configuration" } ] }, { "type": "text", "value": ", which can be useful when setting it for a single test or a subset of tests." } ] }, { "type": "code", "lang": null, "meta": null, "value": "it( 'removes keystroke delay for all typing in this test', { keystrokeDelay: 0 }, () => { cy.get('input').eq(0).type('fast typing') cy.get('input').eq(1).type('more fast typing') })describe( 'removes keystroke delay in all tests in this suite', { keystrokeDelay: 0 }, () => { it('types fast in the first input', () => { cy.get('input').eq(0).type('fast typing') }) it('types fast in the second input', () => { cy.get('input').eq(1).type('more fast typing') }) })" }, { "type": "heading", "depth": 2, "children": [ { "type": "text", "value": "See also" } ] }, { "type": "list", "ordered": false, "start": null, "spread": false, "children": [ { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/api/commands/press.md", "children": [ { "type": "text", "value": "`cy.press()`" } ] } ] } ] }, { "type": "listItem", "spread": false, "checked": null, "children": [ { "type": "paragraph", "children": [ { "type": "link", "title": null, "url": "/llm/markdown/api/commands/type.md", "children": [ { "type": "text", "value": "`.type()`" } ] } ] } ] } ] } ] }, "token_estimate": 521 }