Skip to content

Adding docs for code in the refrence. #7902

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.

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

Open
wants to merge 2 commits into
base: dev-2.0
Choose a base branch
from
Open
Changes from all commits
Commits
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
114 changes: 112 additions & 2 deletions src/events/keyboard.js
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,6 @@ function keyboard(p5, fn){
*/

fn.keyIsPressed = false;
fn.code = null;

/**
* A `String` system variable that contains the value of the last key typed.
Expand Down Expand Up @@ -195,6 +194,117 @@ function keyboard(p5, fn){
*/
fn.key = '';

/**
* The `code` property represents a physical key on the keyboard (as opposed
* to the character generated by pressing the key). In other words, this
* property returns a value that isn't altered by keyboard layout or the state
* of the modifier keys.
*
* This property is useful when you want to handle keys based on their
* physical positions on the input device rather than the characters associated
* with those keys;
*
* Unlike <a href="#/p5/key">key</a>, the `code` property differentiates between
* physical keys that generate the same character—for example, `CtrlLeft` and
* `CtrlRight`—so each can be handled independently.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think linking to the mozilla code docs at the end of this would be useful?

*
* Pressing the key physically labeled “A” always yields `KeyA`, regardless
* of the current keyboard layout (QWERTY, Dvorak, AZERTY, etc.) or the character
* that appears in a text field.
*
* The code property returns a plain string (e.g., 'ArrowRight'). You can
* compare it directly with string literals:
* ```js
* if (code === 'ArrowRight') {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think because keyIsDown is a backwards-compatible pattern with the system variables, we should only show that in the example code, what do you think?

And explain that it's the same as code === 'ArrowRight' and key === 'ArrowRight'

* // …
* }
* ```
*
* For extra clarity, you can instead use the predefined key-code constants
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the way these are introduced and described in the previous docs (https://p5js.org/reference/p5/keyCode/) is really concise, maybe this can be used instead? And not make it sound like an optional/extra, but rather the recommended way to use keyboard events?

* provided by p5.js—`BACKSPACE`, `DELETE`, `ENTER`, `RETURN`, `TAB`, `ESCAPE`, `SHIFT`,
* `CONTROL`, `OPTION`, `ALT`, `UP_ARROW`, `DOWN_ARROW`, `LEFT_ARROW`, and `RIGHT_ARROW`.
* These are simply shorthands for the same string values:
* ```js
* if (code === RIGHT_ARROW) {
* // ..
* }
* ```
*
* @property {String} code
* @readOnly
*
* @example
* <div>
* <code>
* // Click on the canvas to begin detecting key presses.
*
* function setup() {
* createCanvas(100, 100);
*
* describe(
* 'A gray square. The last key pressed is displayed at the center.'
* );
* }
*
* function draw() {
* background(200);
*
* // Style the text.
* textAlign(CENTER);
* textSize(16);
*
* // Display the last key pressed.
* text(code, 50, 50);
* }
* </code>
* </div>
*
* <div>
* <code>
* // Click on the canvas to begin detecting key presses.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @perminder-17 ! Apologies for the delay on this. What do you think about linking to the code docs (https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code) at the end of the description - and also adding an example that's inspired by their interactive one? (Or by this one https://www.toptal.com/developers/keycode that we have linked before). Something that shows each of the values of key and code? Here's a sketch I made: https://editor.p5js.org/ksen0/sketches/oxgLK9HIV you're welcoem to use it as a starting point if you think it's a good idea. That sketch is actually completely backwards compatible except for the line with code so maybe it could also be added to the 1.x reference?

Lastly, while reviewing the transition guide I suggested an overview table https://github.com/processing/p5.js-compatibility/pull/27/files#r2156196242 - maybe the 2.x reference could use the info in just the second column, if you think it improves clarity?

*
* let x = 50;
* let y = 50;
*
* function setup() {
* createCanvas(100, 100);
*
* background(200);
*
* describe(
* 'A gray square with a black circle at its center. The circle moves when the user presses an arrow key. It leaves a trail as it moves.'
* );
* }
*
* function draw() {
* // Update x and y if an arrow key is pressed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about using keyIsDown here as well? https://editor.p5js.org/ksen0/sketches/vrMANhunx Main benefit: backwards compatible snippet. Main drawback: makes this reference page less standalone / use another function. Up to you if you think it's a good idea!

* if (code === LEFT_ARROW) {
* x -= 1;
* }
*
* if (code === RIGHT_ARROW) {
* x += 1;
* }
*
* if (code === UP_ARROW) {
* y -= 1;
* }
*
* if (code === DOWN_ARROW) {
* y += 1;
* }
*
* // Style the circle.
* fill(0);
*
* // Draw the circle.
* circle(x, y, 5);
* }
* </code>
* </div>
*/
fn.code = '';

/**
* A `Number` system variable that contains the code of the last key pressed.
*
Expand Down Expand Up @@ -652,7 +762,7 @@ function keyboard(p5, fn){
if (!this._areDownKeys()) {
this.keyIsPressed = false;
this.key = '';
this.code = null;
this.code = '';
} else {
// If other keys are still pressed, update code to the last pressed key
const lastPressedCode = Object.keys(this._downKeyCodes).pop();
Expand Down