Keycodes utilities for WordPress, used to check the key pressed in events like onKeyDown
. Contains keycodes constants for keyboard keys like DOWN
, UP
, ENTER
, etc.
Install the module
npm install @wordpress/keycodes --save
This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default
in your code.
Check which key was used in an onKeyDown
event:
import { DOWN, ENTER } from '@wordpress/keycodes';
// [...]
onKeyDown( event ) {
const { keyCode } = event;
if ( keyCode === DOWN ) {
alert( 'You pressed the down arrow!' );
} else if ( keyCode === ENTER ) {
alert( 'You pressed the enter key!' );
} else {
alert( 'You pressed another key.' );
}
}
Keycode for ALT key.
Keycode for BACKSPACE key.
Keycode for COMMAND/META key.
Keycode for CTRL key.
Keycode for DELETE key.
An object that contains functions to display shortcuts.
Usage
// Assuming macOS:
displayShortcut.primary( 'm' );
// "⌘M"
Type
WPModifierHandler<WPKeyHandler<string>>
Keyed map of functions to display shortcuts.
Return an array of the parts of a keyboard shortcut chord for display.
Usage
// Assuming macOS:
displayShortcutList.primary( 'm' );
// [ "⌘", "M" ]
Type
WPModifierHandler<WPKeyHandler<string[]>>
Keyed map of functions to shortcut sequences.
Keycode for DOWN key.
Keycode for END key.
Keycode for ENTER key.
Keycode for ESCAPE key.
Keycode for F10 key.
Keycode for HOME key.
An object that contains functions to check if a keyboard event matches a predefined shortcut combination.
Usage
// Assuming an event for ⌘M key press:
isKeyboardEvent.primary( event, 'm' );
// true
Type
WPModifierHandler<WPEventKeyHandler>
Keyed map of functions to match events.
Keycode for LEFT key.
Object that contains functions that return the available modifier depending on platform.
Type
WPModifierHandler< ( isApple: () => boolean ) => WPModifierPart[]>
Keycode for PAGEDOWN key.
Keycode for PAGEUP key.
An object that contains functions to get raw shortcuts.
These are intended for user with the KeyboardShortcuts.
Usage
// Assuming macOS:
rawShortcut.primary( 'm' );
// "meta+m""
Type
WPModifierHandler<WPKeyHandler<string>>
Keyed map of functions to raw shortcuts.
Keycode for RIGHT key.
Keycode for SHIFT key.
An object that contains functions to return an aria label for a keyboard shortcut.
Usage
// Assuming macOS:
shortcutAriaLabel.primary( '.' );
// "Command + Period"
Type
WPModifierHandler<WPKeyHandler<string>>
Keyed map of functions to shortcut ARIA labels.
Keycode for SPACE key.
Keycode for TAB key.
Keycode for UP key.
Keycode for ZERO key.