@wordpress/keycodes/build/index.js

Keycodes utilities for WordPress. Used to check for keyboard events across browsers/operating systems.

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.displayShortcutList = exports.displayShortcut = exports.ZERO = exports.UP = exports.TAB = exports.SPACE = exports.SHIFT = exports.RIGHT = exports.PAGEUP = exports.PAGEDOWN = exports.LEFT = exports.HOME = exports.F10 = exports.ESCAPE = exports.ENTER = exports.END = exports.DOWN = exports.DELETE = exports.CTRL = exports.COMMAND = exports.BACKSPACE = exports.ALT = void 0;
Object.defineProperty(exports, "isAppleOS", {
  enumerable: true,
  get: function () {
    return _platform.isAppleOS;
  }
});
exports.shortcutAriaLabel = exports.rawShortcut = exports.modifiers = exports.isKeyboardEvent = void 0;
var _i18n = require("@wordpress/i18n");
var _platform = require("./platform");
/**
 * Note: The order of the modifier keys in many of the [foo]Shortcut()
 * functions in this file are intentional and should not be changed. They're
 * designed to fit with the standard menu keyboard shortcuts shown in the
 * user's platform.
 *
 * For example, on MacOS menu shortcuts will place Shift before Command, but
 * on Windows Control will usually come first. So don't provide your own
 * shortcut combos directly to keyboardShortcut().
 */

/**
 * WordPress dependencies
 */

/**
 * Internal dependencies
 */

/**
 * External dependencies
 */

/**
 * An object of handler functions for each of the possible modifier
 * combinations. A handler will return a value for a given key.
 */

/**
 * Keycode for BACKSPACE key.
 */
const BACKSPACE = exports.BACKSPACE = 8;

/**
 * Keycode for TAB key.
 */
const TAB = exports.TAB = 9;

/**
 * Keycode for ENTER key.
 */
const ENTER = exports.ENTER = 13;

/**
 * Keycode for ESCAPE key.
 */
const ESCAPE = exports.ESCAPE = 27;

/**
 * Keycode for SPACE key.
 */
const SPACE = exports.SPACE = 32;

/**
 * Keycode for PAGEUP key.
 */
const PAGEUP = exports.PAGEUP = 33;

/**
 * Keycode for PAGEDOWN key.
 */
const PAGEDOWN = exports.PAGEDOWN = 34;

/**
 * Keycode for END key.
 */
const END = exports.END = 35;

/**
 * Keycode for HOME key.
 */
const HOME = exports.HOME = 36;

/**
 * Keycode for LEFT key.
 */
const LEFT = exports.LEFT = 37;

/**
 * Keycode for UP key.
 */
const UP = exports.UP = 38;

/**
 * Keycode for RIGHT key.
 */
const RIGHT = exports.RIGHT = 39;

/**
 * Keycode for DOWN key.
 */
const DOWN = exports.DOWN = 40;

/**
 * Keycode for DELETE key.
 */
const DELETE = exports.DELETE = 46;

/**
 * Keycode for F10 key.
 */
const F10 = exports.F10 = 121;

/**
 * Keycode for ALT key.
 */
const ALT = exports.ALT = 'alt';

/**
 * Keycode for CTRL key.
 */
const CTRL = exports.CTRL = 'ctrl';

/**
 * Keycode for COMMAND/META key.
 */
const COMMAND = exports.COMMAND = 'meta';

/**
 * Keycode for SHIFT key.
 */
const SHIFT = exports.SHIFT = 'shift';

/**
 * Keycode for ZERO key.
 */
const ZERO = exports.ZERO = 48;
/**
 * Capitalise the first character of a string.
 * @param string String to capitalise.
 * @return Capitalised string.
 */
function capitaliseFirstCharacter(string) {
  return string.length < 2 ? string.toUpperCase() : string.charAt(0).toUpperCase() + string.slice(1);
}

/**
 * Map the values of an object with a specified callback and return the result object.
 *
 * @template T The object type
 * @template R The return type of the mapping function
 *
 * @param    object Object to map values of.
 * @param    mapFn  Mapping function to apply to each value.
 * @return Object with the same keys and transformed values.
 */
function mapValues(object, mapFn) {
  return Object.fromEntries(Object.entries(object).map(([key, value]) => [key, mapFn(value)]));
}

/**
 * Object that contains functions that return the available modifier
 * depending on platform.
 */
const modifiers = exports.modifiers = {
  primary: _isApple => _isApple() ? [COMMAND] : [CTRL],
  primaryShift: _isApple => _isApple() ? [SHIFT, COMMAND] : [CTRL, SHIFT],
  primaryAlt: _isApple => _isApple() ? [ALT, COMMAND] : [CTRL, ALT],
  secondary: _isApple => _isApple() ? [SHIFT, ALT, COMMAND] : [CTRL, SHIFT, ALT],
  access: _isApple => _isApple() ? [CTRL, ALT] : [SHIFT, ALT],
  ctrl: () => [CTRL],
  alt: () => [ALT],
  ctrlShift: () => [CTRL, SHIFT],
  shift: () => [SHIFT],
  shiftAlt: () => [SHIFT, ALT],
  undefined: () => []
};

/**
 * An object that contains functions to get raw shortcuts.
 *
 * These are intended for user with the KeyboardShortcuts.
 *
 * @example
 * ```js
 * // Assuming macOS:
 * rawShortcut.primary( 'm' )
 * // "meta+m""
 * ```
 */
const rawShortcut = exports.rawShortcut = /* @__PURE__ */
mapValues(modifiers, modifier => {
  return (character, _isApple = _platform.isAppleOS) => {
    return [...modifier(_isApple), character.toLowerCase()].join('+');
  };
});

/**
 * Return an array of the parts of a keyboard shortcut chord for display.
 *
 * @example
 * ```js
 * // Assuming macOS:
 * displayShortcutList.primary( 'm' );
 * // [ "⌘", "M" ]
 * ```
 *
 * Keyed map of functions to shortcut sequences.
 */
const displayShortcutList = exports.displayShortcutList = /* @__PURE__ */
mapValues(modifiers, modifier => {
  return (character, _isApple = _platform.isAppleOS) => {
    const isApple = _isApple();
    const replacementKeyMap = {
      [ALT]: isApple ? '⌥' : 'Alt',
      [CTRL]: isApple ? '⌃' : 'Ctrl',
      // Make sure ⌃ is the U+2303 UP ARROWHEAD unicode character and not the caret character.
      [COMMAND]: '⌘',
      [SHIFT]: isApple ? '⇧' : 'Shift'
    };
    const modifierKeys = modifier(_isApple).reduce((accumulator, key) => {
      var _replacementKeyMap$ke;
      const replacementKey = (_replacementKeyMap$ke = replacementKeyMap[key]) !== null && _replacementKeyMap$ke !== void 0 ? _replacementKeyMap$ke : key;
      // If on the Mac, adhere to platform convention and don't show plus between keys.
      if (isApple) {
        return [...accumulator, replacementKey];
      }
      return [...accumulator, replacementKey, '+'];
    }, []);
    return [...modifierKeys, capitaliseFirstCharacter(character)];
  };
});

/**
 * An object that contains functions to display shortcuts.
 *
 * @example
 * ```js
 * // Assuming macOS:
 * displayShortcut.primary( 'm' );
 * // "⌘M"
 * ```
 *
 * Keyed map of functions to display shortcuts.
 */
const displayShortcut = exports.displayShortcut = /* @__PURE__ */
mapValues(displayShortcutList, shortcutList => {
  return (character, _isApple = _platform.isAppleOS) => shortcutList(character, _isApple).join('');
});

/**
 * An object that contains functions to return an aria label for a keyboard
 * shortcut.
 *
 * @example
 * ```js
 * // Assuming macOS:
 * shortcutAriaLabel.primary( '.' );
 * // "Command + Period"
 * ```
 *
 * Keyed map of functions to shortcut ARIA labels.
 */
const shortcutAriaLabel = exports.shortcutAriaLabel = /* @__PURE__ */
mapValues(modifiers, modifier => {
  return (character, _isApple = _platform.isAppleOS) => {
    const isApple = _isApple();
    const replacementKeyMap = {
      [SHIFT]: 'Shift',
      [COMMAND]: isApple ? 'Command' : 'Control',
      [CTRL]: 'Control',
      [ALT]: isApple ? 'Option' : 'Alt',
      /* translators: comma as in the character ',' */
      ',': (0, _i18n.__)('Comma'),
      /* translators: period as in the character '.' */
      '.': (0, _i18n.__)('Period'),
      /* translators: backtick as in the character '`' */
      '`': (0, _i18n.__)('Backtick'),
      /* translators: tilde as in the character '~' */
      '~': (0, _i18n.__)('Tilde')
    };
    return [...modifier(_isApple), character].map(key => {
      var _replacementKeyMap$ke2;
      return capitaliseFirstCharacter((_replacementKeyMap$ke2 = replacementKeyMap[key]) !== null && _replacementKeyMap$ke2 !== void 0 ? _replacementKeyMap$ke2 : key);
    }).join(isApple ? ' ' : ' + ');
  };
});

/**
 * From a given KeyboardEvent, returns an array of active modifier constants for
 * the event.
 *
 * @param event Keyboard event.
 *
 * @return Active modifier constants.
 */
function getEventModifiers(event) {
  return [ALT, CTRL, COMMAND, SHIFT].filter(key => event[`${key}Key`]);
}

/**
 * An object that contains functions to check if a keyboard event matches a
 * predefined shortcut combination.
 *
 * @example
 * ```js
 * // Assuming an event for ⌘M key press:
 * isKeyboardEvent.primary( event, 'm' );
 * // true
 * ```
 *
 * Keyed map of functions to match events.
 */
const isKeyboardEvent = exports.isKeyboardEvent = /* @__PURE__ */
mapValues(modifiers, getModifiers => {
  return (event, character, _isApple = _platform.isAppleOS) => {
    const mods = getModifiers(_isApple);
    const eventMods = getEventModifiers(event);
    const replacementWithShiftKeyMap = {
      Comma: ',',
      Backslash: '\\',
      // Windows returns `\` for both IntlRo and IntlYen.
      IntlRo: '\\',
      IntlYen: '\\'
    };
    const modsDiff = mods.filter(mod => !eventMods.includes(mod));
    const eventModsDiff = eventMods.filter(mod => !mods.includes(mod));
    if (modsDiff.length > 0 || eventModsDiff.length > 0) {
      return false;
    }
    let key = event.key.toLowerCase();
    if (!character) {
      return mods.includes(key);
    }
    if (event.altKey && character.length === 1) {
      key = String.fromCharCode(event.keyCode).toLowerCase();
    }

    // `event.key` returns the value of the key pressed, taking into the state of
    // modifier keys such as `Shift`. If the shift key is pressed, a different
    // value may be returned depending on the keyboard layout. It is necessary to
    // convert to the physical key value that don't take into account keyboard
    // layout or modifier key state.
    if (event.shiftKey && character.length === 1 && replacementWithShiftKeyMap[event.code]) {
      key = replacementWithShiftKeyMap[event.code];
    }

    // For backwards compatibility.
    if (character === 'del') {
      character = 'delete';
    }
    return key === character.toLowerCase();
  };
});
//# sourceMappingURL=index.js.map