Skip to content

docs(keyboard): clarify keyIsDown() documentation for key codes and browser compatibility #7812

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
perminder-17 merged 1 commit into from
May 15, 2025
Merged

docs(keyboard): clarify keyIsDown() documentation for key codes and browser compatibility #7812

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 10 additions & 4 deletions src/events/keyboard.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -832,10 +832,16 @@ function keyboard(p5, fn){
* }
* ```
*
* `keyIsDown()` can check for key presses using
* <a href="#/p5/keyCode">keyCode</a> values, as in `keyIsDown(37)` or
* `keyIsDown(LEFT_ARROW)`. Key codes can be found on websites such as
* <a href="https://keycode.info" target="_blank">keycode.info</a>.
* `keyIsDown()` can check for key presses using strings based on
* <a href="https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key" target="_blank">KeyboardEvent.key</a>
* or <a href="https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code" target="_blank">KeyboardEvent.code</a> values,
* such as `keyIsDown('x')` or `keyIsDown('ArrowLeft')`.
*
* Note: In p5.js 2.0 and newer, numeric keycodes (such as 88 for 'X') are no longer supported.
* This is a breaking change from previous versions.
*
* You can still use the p5 constants like `LEFT_ARROW` which now map to string values
* internally rather than numeric codes.
*
* @method keyIsDown
* @param {Number|String} code key to check.
Expand Down