@wordpress/keycodes 是 WordPress 的键盘键码实用工具包，用于在 onKeyDown 等事件中检查按下的键。它提供了键盘键的常量（如 DOWN、ENTER）和辅助函数，以简化键盘事件处理和快捷键管理。
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.' );
}
}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.
An object that contains functions to get shortcuts in a format compatible with the aria-keyshortcuts HTML attribute.
Note: The provided shortcut character strings (ie. not the modifiers) should follow the values specified in the UI Events KeyboardEvent key Values spec — for example, “Enter”, “Tab”, “ArrowRight”, “PageDown”, “Escape”, “Plus”, or “F1”. The spacebar key should be represented with the “Space” string (an exception to the UI Events KeyboardEvent key Values spec).
Related
Usage
// Assuming macOS:
ariaKeyShortcut.primary( 'm' );
// "Meta+M"
ariaKeyShortcut.primaryAlt( 'm' );
// "Meta+Alt+M"
// Assuming Windows:
ariaKeyShortcut.primary( 'm' );
// "Control+M"
ariaKeyShortcut.primaryAlt( 'm' );
// "Control+Alt+M"
ariaKeyShortcut.primaryShift( 'del' );
// "Control+Shift+Delete"
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"
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" ]
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.
Return true if platform is MacOS.
Parameters
Window: window object by default; used for DI testing.Returns
boolean: True if MacOS; false otherwise.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
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< WPModifier >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"
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"
Keyed map of functions to shortcut ARIA labels.
Keycode for SPACE key.
Keycode for TAB key.
Keycode for UP key.
Keycode for ZERO key.
This is an individual package that’s part of the Gutenberg project. The project is organized as a monorepo. It’s made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.
To find out more about contributing to this package or Gutenberg as a whole, please read the project’s main contributor guide.