Skip to content

WP Package: Replace keyCode with key in key event handling in the wp folder #9359

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

Open
R1shabh-Gupta wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

WP Package: Replace keyCode with key in key event handling in the wp folder #9359

Show file tree
Hide file tree
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
6 changes: 2 additions & 4 deletions src/js/_enqueues/wp/code-editor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,16 +227,14 @@ if ( 'undefined' === typeof window.wp.codeEditor ) {
$textarea.data( 'next-tab-blurs', false );
});
codemirror.on( 'keydown', function onKeydown( editor, event ) {
var tabKeyCode = 9, escKeyCode = 27;

// Take note of the ESC keypress so that the next TAB can focus outside the editor.
if ( escKeyCode === event.keyCode ) {
if ( 'Escape' === event.key ) {
$textarea.data( 'next-tab-blurs', true );
return;
}

// Short-circuit if tab key is not being pressed or the tab key press should move focus.
if ( tabKeyCode !== event.keyCode || ! $textarea.data( 'next-tab-blurs' ) ) {
if ( 'Tab' !== event.key || ! $textarea.data( 'next-tab-blurs' ) ) {
return;
}

Expand Down
17 changes: 8 additions & 9 deletions src/js/_enqueues/wp/customize/controls.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1778,17 +1778,17 @@
}

// Pressing the right arrow key fires a theme:next event.
if ( 39 === event.keyCode ) {
if ( 'ArrowRight' === event.key ) {
section.nextTheme();
}

// Pressing the left arrow key fires a theme:previous event.
if ( 37 === event.keyCode ) {
if ( 'ArrowLeft' === event.key ) {
section.previousTheme();
}

// Pressing the escape key fires a theme:collapse event.
if ( 27 === event.keyCode ) {
if ( 'Escape' === event.key ) {
if ( section.$body.hasClass( 'modal-open' ) ) {

// Escape from the details modal.
Expand Down Expand Up @@ -2637,7 +2637,7 @@

// Return if it's not the tab key
// When navigating with prev/next focus is already handled.
if ( 9 !== event.keyCode ) {
if ( 'Tab' !== event.key ) {
return;
}

Expand Down Expand Up @@ -5462,8 +5462,7 @@

// Prevent collapsing section when hitting Esc to tab out of editor.
control.editor.codemirror.on( 'keydown', function onKeydown( codemirror, event ) {
var escKeyCode = 27;
if ( escKeyCode === event.keyCode ) {
if ( 'Escape' === event.key ) {
event.stopPropagation();
}
});
Expand Down Expand Up @@ -5545,9 +5544,9 @@
} );

$textarea.on( 'keydown', function onKeydown( event ) {
var selectionStart, selectionEnd, value, tabKeyCode = 9, escKeyCode = 27;
var selectionStart, selectionEnd, value;

if ( escKeyCode === event.keyCode ) {
if ( 'Escape' === event.key ) {
if ( ! $textarea.data( 'next-tab-blurs' ) ) {
$textarea.data( 'next-tab-blurs', true );
event.stopPropagation(); // Prevent collapsing the section.
Expand All @@ -5556,7 +5555,7 @@
}

// Short-circuit if tab key is not being pressed or if a modifier key *is* being pressed.
if ( tabKeyCode !== event.keyCode || event.ctrlKey || event.altKey || event.shiftKey ) {
if ( 'Tab' !== event.key || event.ctrlKey || event.altKey || event.shiftKey ) {
return;
}

Expand Down
18 changes: 9 additions & 9 deletions src/js/_enqueues/wp/editor/dfw.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1166,30 +1166,30 @@
*/
function fadeOut( event ) {
var isMac,
key = event && event.keyCode;
key = event && event.key;

if ( window.navigator.platform ) {
isMac = ( window.navigator.platform.indexOf( 'Mac' ) > -1 );
}

// Fade in and returns on Escape and keyboard shortcut Alt+Shift+W and Ctrl+Opt+W.
if ( key === 27 || ( key === 87 && event.altKey && ( ( ! isMac && event.shiftKey ) || ( isMac && event.ctrlKey ) ) ) ) {
if ( key === 'Escape' || ( key === 'w' && event.altKey && ( ( ! isMac && event.shiftKey ) || ( isMac && event.ctrlKey ) ) ) ) {
fadeIn( event );
return;
}

// Return if any of the following keys or combinations of keys is pressed.
if ( event && ( event.metaKey || ( event.ctrlKey && ! event.altKey ) || ( event.altKey && event.shiftKey ) || ( key && (
// Special keys ( tab, ctrl, alt, esc, arrow keys... ).
( key <= 47 && key !== 8 && key !== 13 && key !== 32 && key !== 46 ) ||
( ['Tab', 'Control', 'Alt', 'Shift', 'Escape', 'CapsLock', 'NumLock', 'ScrollLock', 'Pause', 'Insert', 'Home', 'End', 'PageUp', 'PageDown', 'ArrowUp', 'ArrowDown', 'ArrowLeft', 'ArrowRight', 'PrintScreen'].includes(key) ) ||
// Windows keys.
( key >= 91 && key <= 93 ) ||
( ['Meta', 'OS', 'ContextMenu'].includes(key) ) ||
// F keys.
( key >= 112 && key <= 135 ) ||
// Num Lock, Scroll Lock, OEM.
( key >= 144 && key <= 150 ) ||
( /^F([1-9]|1[0-9]|2[0-4])$/.test(key) ) ||
// OEM or non-printable.
key >= 224
key.startsWith('Dead') ||
key === 'Unidentified' ||
key.length > 1 && !['Enter', 'Backspace', 'Delete', ' '].includes(key)
) ) ) ) {
return;
}
Expand Down Expand Up @@ -1446,7 +1446,7 @@
* @return {void}
*/
function toggleViaKeyboard( event ) {
if ( event.altKey && event.shiftKey && 87 === event.keyCode ) {
if ( event.altKey && event.shiftKey && 'w' === event.key ) {
toggle();
}
}
Expand Down
33 changes: 10 additions & 23 deletions src/js/_enqueues/wp/theme-plugin-editor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,19 +523,6 @@ wp.themePluginEditor = (function( $ ) {

elem = elem.nextElementSibling;
}

this.keyCode = Object.freeze({
RETURN: 13,
SPACE: 32,
PAGEUP: 33,
PAGEDOWN: 34,
END: 35,
HOME: 36,
LEFT: 37,
UP: 38,
RIGHT: 39,
DOWN: 40
});
};

TreeitemLink.prototype.init = function () {
Expand Down Expand Up @@ -602,7 +589,7 @@ wp.themePluginEditor = (function( $ ) {
}

if (event.shift) {
if (event.keyCode == this.keyCode.SPACE || event.keyCode == this.keyCode.RETURN) {
if (event.key == ' ' || event.key == 'Enter') {
event.stopPropagation();
this.stopDefaultClick = true;
}
Expand All @@ -613,9 +600,9 @@ wp.themePluginEditor = (function( $ ) {
}
}
else {
switch (event.keyCode) {
case this.keyCode.SPACE:
case this.keyCode.RETURN:
switch (event.key) {
case ' ':
case 'Enter':
if (this.isExpandable) {
if (this.isExpanded()) {
this.tree.collapseTreeitem(this);
Expand All @@ -631,17 +618,17 @@ wp.themePluginEditor = (function( $ ) {
}
break;

case this.keyCode.UP:
case 'ArrowUp':
this.tree.setFocusToPreviousItem(this);
flag = true;
break;

case this.keyCode.DOWN:
case 'ArrowDown':
this.tree.setFocusToNextItem(this);
flag = true;
break;

case this.keyCode.RIGHT:
case 'ArrowRight':
if (this.isExpandable) {
if (this.isExpanded()) {
this.tree.setFocusToNextItem(this);
Expand All @@ -653,7 +640,7 @@ wp.themePluginEditor = (function( $ ) {
flag = true;
break;

case this.keyCode.LEFT:
case 'ArrowLeft':
if (this.isExpandable && this.isExpanded()) {
this.tree.collapseTreeitem(this);
flag = true;
Expand All @@ -666,12 +653,12 @@ wp.themePluginEditor = (function( $ ) {
}
break;

case this.keyCode.HOME:
case 'Home':
this.tree.setFocusToFirstItem();
flag = true;
break;

case this.keyCode.END:
case 'End':
this.tree.setFocusToLastItem();
flag = true;
break;
Expand Down
14 changes: 7 additions & 7 deletions src/js/_enqueues/wp/theme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -742,7 +742,7 @@ themes.view.Details = wp.Backbone.View.extend({

// Detect if the click is inside the overlay and don't close it
// unless the target was the div.back button.
if ( $( event.target ).is( '.theme-backdrop' ) || $( event.target ).is( '.close' ) || event.keyCode === 27 ) {
if ( $( event.target ).is( '.theme-backdrop' ) || $( event.target ).is( '.close' ) || event.key === 'Escape' ) {

// Add a temporary closing class while overlay fades out.
$( 'body' ).addClass( 'closing-overlay' );
Expand Down Expand Up @@ -1007,7 +1007,7 @@ themes.view.Preview = themes.view.Details.extend({

keyEvent: function( event ) {
// The escape key closes the preview.
if ( event.keyCode === 27 ) {
if ( event.key === 'Escape' ) {
this.undelegateEvents();
this.close();
}
Expand All @@ -1018,12 +1018,12 @@ themes.view.Preview = themes.view.Details.extend({
}

// The right arrow key, next theme.
if ( event.keyCode === 39 ) {
if ( event.key === 'ArrowRight' ) {
_.once( this.nextTheme() );
}

// The left arrow key, previous theme.
if ( event.keyCode === 37 ) {
if ( event.key === 'ArrowLeft' ) {
this.previousTheme();
}
},
Expand Down Expand Up @@ -1127,17 +1127,17 @@ themes.view.Themes = wp.Backbone.View.extend({
}

// Pressing the right arrow key fires a theme:next event.
if ( event.keyCode === 39 ) {
if ( event.key === 'ArrowRight' ) {
self.overlay.nextTheme();
}

// Pressing the left arrow key fires a theme:previous event.
if ( event.keyCode === 37 ) {
if ( event.key === 'ArrowLeft' ) {
self.overlay.previousTheme();
}

// Pressing the escape key fires a theme:collapse event.
if ( event.keyCode === 27 ) {
if ( event.key === 'Escape' ) {
self.overlay.collapse( event );
}
});
Expand Down
4 changes: 2 additions & 2 deletions src/js/_enqueues/wp/updates.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2188,9 +2188,9 @@
* @param {Event} event Event interface.
*/
wp.updates.keydown = function( event ) {
if ( 27 === event.keyCode ) {
if ( 'Escape' === event.key ) {
wp.updates.requestForCredentialsModalCancel();
} else if ( 9 === event.keyCode ) {
} else if ( 'Tab' === event.key ) {

// #upgrade button must always be the last focus-able element in the dialog.
if ( 'upgrade' === event.target.id && ! event.shiftKey ) {
Expand Down
3 changes: 1 addition & 2 deletions src/js/_enqueues/wp/widgets/custom-html.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,8 +262,7 @@ wp.customHtmlWidgets = ( function( $ ) {
// Prevent hitting Esc from collapsing the widget control.
if ( wp.customize ) {
control.editor.codemirror.on( 'keydown', function onKeydown( codemirror, event ) {
var escKeyCode = 27;
if ( escKeyCode === event.keyCode ) {
if ( 'Escape' === event.key ) {
event.stopPropagation();
}
});
Expand Down
Loading