@wordpress/keycodes Edit

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 Installation

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.

Top ↑

Usage Usage

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.' );
    }
}

Top ↑

API API

Top ↑

ALT ALT

Keycode for ALT key.

Top ↑

BACKSPACE BACKSPACE

Keycode for BACKSPACE key.

Top ↑

COMMAND COMMAND

Keycode for COMMAND/META key.

Top ↑

CTRL CTRL

Keycode for CTRL key.

Top ↑

DELETE DELETE

Keycode for DELETE key.

Top ↑

displayShortcut displayShortcut

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.

Top ↑

displayShortcutList displayShortcutList

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.

Top ↑

DOWN DOWN

Keycode for DOWN key.

Top ↑

END END

Keycode for END key.

Top ↑

ENTER ENTER

Keycode for ENTER key.

Top ↑

ESCAPE ESCAPE

Keycode for ESCAPE key.

Top ↑

F10 F10

Keycode for F10 key.

Top ↑

HOME HOME

Keycode for HOME key.

Top ↑

isKeyboardEvent isKeyboardEvent

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.

Top ↑

LEFT LEFT

Keycode for LEFT key.

Top ↑

modifiers modifiers

Object that contains functions that return the available modifier
depending on platform.

Type

  • WPModifierHandler< ( isApple: () => boolean ) => WPModifierPart[]>

Top ↑

PAGEDOWN PAGEDOWN

Keycode for PAGEDOWN key.

Top ↑

PAGEUP PAGEUP

Keycode for PAGEUP key.

Top ↑

rawShortcut rawShortcut

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.

Top ↑

Keycode for RIGHT key.

Top ↑

SHIFT SHIFT

Keycode for SHIFT key.

Top ↑

shortcutAriaLabel shortcutAriaLabel

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.

Top ↑

SPACE SPACE

Keycode for SPACE key.

Top ↑

TAB TAB

Keycode for TAB key.

Top ↑

UP UP

Keycode for UP key.

Top ↑

ZERO ZERO

Keycode for ZERO key.