# @wordpress/keycodes > Keycodes utilities for WordPress. Used to check for keyboard events across browsers/operating systems. Latest version **4.55.0** (published 2026-09-10) · GPL-2.0-or-later license · 0 weekly downloads ## Install ```sh npm install @wordpress/keycodes pnpm add @wordpress/keycodes yarn add @wordpress/keycodes bun add @wordpress/keycodes ``` ## Health **Score 70/100 (B)** — status: active. Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; popular repo. Warnings: low downloads. ## Facts | | | |---|---| | Version | 4.55.0 | | Published | 2026-09-10 | | First published | 2018-07-02 | | Weekly downloads | 0 | | License | GPL-2.0-or-later | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >=18.12.0 | | Dependencies | 1 | | Unpacked size | 111.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 11754 | | Author | The WordPress Contributors | | Maintainers | garypendergast, adamsilverstein, gziolo, ntwb, riad, noisysocks, kadamwhite, gutenbergplugin, jorgefilipecosta, ellatrix, iandunn206, whyisjake, ockham, sirreal, nosolosw, wpisabel, ntsekouras, nerrad, desrosj, talldanwp, peterwilsoncc, ryanwelcher, mamaduka, aduth, johnbillion | | Keywords | wordpress, gutenberg, keycodes | ## Links - npm: https://www.npmjs.com/package/@wordpress/keycodes - Repository: https://github.com/WordPress/gutenberg - Homepage: https://github.com/WordPress/gutenberg/tree/HEAD/packages/keycodes/README.md - Issues: https://github.com/WordPress/gutenberg/issues - npm.io page: https://npm.io/package/@wordpress/keycodes ## Dependencies (1) - [@wordpress/i18n](https://npm.io/package/@wordpress/i18n.md) ^6.28.0 ## Recent versions - 4.55.0 (latest) — 2026-09-10 - 4.54.1-next.v.202609031004.0 (next) — 2026-09-03 - 4.40.1 (wp-7.0) — 2026-06-30 - 4.33.1 (wp-6.9) — 2025-10-28 - 4.19.1 (wp-6.8) — 2025-03-10 - 4.8.2 (wp-6.7) — 2024-09-30 - 4.0.1 (wp-6.6) — 2024-06-11 - 3.51.1 (wp-6.5) — 2024-02-20 - 3.42.13 (wp-6.4) — 2023-11-13 - 3.35.2 (wp-6.3) — 2023-10-12 - 3.26.3 (wp-6.2) — 2023-10-12 - 3.17.1 (wp-6.1) — 2022-09-20 - 3.6.1 (wp-6.0) — 2022-04-19 - 3.2.4 (wp-5.9) — 2021-11-15 - 3.1.2 (patch) — 2021-09-01 - … 248 more at https://npm.io/package/@wordpress/keycodes/versions ## README # Keycodes 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. ## Installation Install the module ```bash 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`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/babel-preset-default#polyfill) in your code._ ## Usage Check which key was used in an `onKeyDown` event: ```js 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.' ); } } ``` ## API ### ALT Keycode for ALT key. ### ariaKeyShortcut An object that contains functions to get shortcuts in a format compatible with the [`aria-keyshortcuts` HTML attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-keyshortcuts). **Note**: The provided shortcut character strings (ie. not the modifiers) should follow the values specified in the [UI Events KeyboardEvent key Values spec](https://www.w3.org/TR/uievents-key/) — 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_ ```js // 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" ``` ### BACKSPACE Keycode for BACKSPACE key. ### COMMAND Keycode for COMMAND/META key. ### CTRL Keycode for CTRL key. ### DELETE Keycode for DELETE key. ### displayShortcut An object that contains functions to display shortcuts. _Usage_ ```js // Assuming macOS: displayShortcut.primary( 'm' ); // "⌘M" ``` Keyed map of functions to display shortcuts. ### displayShortcutList Return an array of the parts of a keyboard shortcut chord for display. _Usage_ ```js // Assuming macOS: displayShortcutList.primary( 'm' ); // [ "⌘", "M" ] ``` Keyed map of functions to shortcut sequences. ### DOWN Keycode for DOWN key. ### END Keycode for END key. ### ENTER Keycode for ENTER key. ### ESCAPE Keycode for ESCAPE key. ### F10 Keycode for F10 key. ### HOME Keycode for HOME key. ### isAppleOS Return true if platform is MacOS. _Parameters_ - _\_window_ `Window`: window object by default; used for DI testing. _Returns_ - `boolean`: True if MacOS; false otherwise. ### isKeyboardEvent An object that contains functions to check if a keyboard event matches a predefined shortcut combination. _Usage_ ```js // Assuming an event for ⌘M key press: isKeyboardEvent.primary( event, 'm' ); // true ``` Keyed map of functions to match events. ### LEFT Keycode for LEFT key. ### modifiers Object that contains functions that return the available modifier depending on platform. _Type_ - `WPModifierHandler< WPModifier >` ### PAGEDOWN Keycode for PAGEDOWN key. ### PAGEUP Keycode for PAGEUP key. ### rawShortcut An object that contains functions to get raw shortcuts. These are intended for use with the KeyboardShortcuts. _Usage_ ```js // Assuming macOS: rawShortcut.primary( 'm' ); // "meta+m" ``` ### RIGHT Keycode for RIGHT key. ### SHIFT Keycode for SHIFT key. ### shortcutAriaLabel An object that contains functions to return an aria label for a keyboard shortcut. _Usage_ ```js // Assuming macOS: shortcutAriaLabel.primary( '.' ); // "Command + Period" ``` Keyed map of functions to shortcut ARIA labels. ### SPACE Keycode for SPACE key. ### TAB Keycode for TAB key. ### UP Keycode for UP key. ### withIgnoreIMEEvents A higher-order function that wraps a keyboard event handler to ensure it is not an IME event. In CJK languages, an IME (Input Method Editor) is used to input complex characters. During an IME composition, keyboard events (e.g. Enter or Escape) can be fired which are intended to control the IME and not the application. These events should be ignored by any application logic. _Parameters_ - _handler_ `( event: E ) => void`: The keyboard event handler to execute after ensuring it was not an IME event. _Returns_ - A wrapped version of the given event handler that ignores IME events. ### ZERO Keycode for ZERO key. ## Contributing to this package 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](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) 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](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md).

Code is Poetry.

--- _Source: https://npm.io/package/@wordpress/keycodes · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._