@playkit-js/playkit-js-ui/src/utils/key-map.ts

[](https://github.com/kaltura/playkit-js-ui/actions/workflows/run_canary_full_flow.yaml) [![code style: prettier](https://img.shields.io/badge/c

/**
 * @deprecated Use the `KeyCode` object instead.
 * see here: https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode
 * For more information on keyboard event codes, refer to the MDN documentation:
 * https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code/code_values
 */
export const KeyMap: {[key: string]: number} = {
  TAB: 9,
  ENTER: 13,
  ESC: 27,
  SPACE: 32,
  END: 35,
  HOME: 36,
  LEFT: 37,
  UP: 38,
  RIGHT: 39,
  DOWN: 40,
  P: 80,
  C: 67,
  F: 70,
  M: 77,
  SEMI_COLON: 186,
  COMMA: 188,
  PERIOD: 190
};

export const KeyCode = {
  Backspace: 'Backspace',
  Tab: 'Tab',
  Enter: 'Enter',
  ShiftLeft: 'ShiftLeft',
  ShiftRight: 'ShiftRight',
  ControlLeft: 'ControlLeft',
  ControlRight: 'ControlRight',
  AltLeft: 'AltLeft',
  AltRight: 'AltRight',
  Pause: 'Pause',
  CapsLock: 'CapsLock',
  Escape: 'Escape',
  Space: 'Space',
  PageUp: 'PageUp',
  PageDown: 'PageDown',
  End: 'End',
  Home: 'Home',
  ArrowLeft: 'ArrowLeft',
  ArrowUp: 'ArrowUp',
  ArrowRight: 'ArrowRight',
  ArrowDown: 'ArrowDown',
  Insert: 'Insert',
  Delete: 'Delete',
  KeyP: 'KeyP',
  KeyC: 'KeyC',
  KeyF: 'KeyF',
  KeyM: 'KeyM',
  KeyR: 'KeyR',
  KeyD: 'KeyD',
  Numpad0: 'Numpad0',
  Semicolon: 'Semicolon',
  Equal: 'Equal',
  Comma: 'Comma',
  Minus: 'Minus',
  Period: 'Period',
  Slash: 'Slash'
};

/**
 * set env for keymap
 * @param {Object} env - env object
 * @returns {void}
 */
export function setEnv(env: any): void {
  KeyMap.SEMI_COLON = env.browser.name.toLowerCase() === 'firefox' ? 59 : 186;
}

/**
 * gets the key name for a certain key code
 * @param {number} keyCode - key code
 * @returns {string} - key name
 */
export function getKeyName(keyCode: number): string {
  for (const keyName in KeyMap) {
    if (KeyMap[keyName] === keyCode) {
      return keyName;
    }
  }
  return 'NOT_FOUND';
}

/**
 * @param {KeyboardEvent} e - Keyboard event
 * @returns {boolean} - whether the given key code is a tab key
 */
export function isTab(e: KeyboardEvent): boolean {
  return isKeyEqual(e.code, KeyCode.Tab);
}

/**
 * @param {KeyboardEvent} e - Keyboard event
 * @returns {boolean} - whether the given key code is an enter key
 */
export function isEnter(e: KeyboardEvent): boolean {
  return isKeyEqual(e.code, KeyCode.Enter);
}

/**
 * @param {KeyboardEvent} e - Keyboard event
 * @returns {boolean} - whether the given key code is an enter key
 */
export function isSpace(e: KeyboardEvent): boolean {
  return isKeyEqual(e.code, KeyCode.Space);
}

/**
 * @param {KeyboardEvent} e - Keyboard event
 * @returns {boolean} - whether the given key code is an esc key
 */
export function isEsc(e: KeyboardEvent): boolean {
  return isKeyEqual(e.code, KeyCode.Escape);
}

/**
 * @param {string} inputKeyCode - input key code
 * @param {string} targetKeyCode - target key code
 * @returns {boolean} - whether the given key code is equals to the input key
 */
function isKeyEqual(inputKeyCode: string, targetKeyCode: string): boolean {
  return inputKeyCode === targetKeyCode;
}