@fluentui/keyboard-keys

@fluentui/keyboard-keys

Contains a set of keyboard constants for key and keyCode comparison in components. This package contains named key values from The w3 uievents-key specification.

Unicode values are not included since there are a lot of locales to consider and they provide no benefit since unicode characters can be used directly in code.

Usage

import { Enter } from '@fluentui/keyboard-keys';

const onKeyDown = (e: React.KeyboardEvent) => {
  if (e.key === Enter) {
    // ...
  }

  // Unicode characters 'a', '1', '%'...
  // should be used directly in code
  if (e.key === 'a') {
    // ...
  }
};

Legacy keyCode

In order to migrate easily from @fluentui/keyboard-key legacy keyCode support is available in this library but is not encouraged for reuse since this propoerty has been deprecated for a while and will be removed in future standards.

import { keyCodes } from '@fluentui/keyboard-keys';

const onKeyDown = (e: React.KeyboardEvent) => {
  if (e.keyCode === keyCodes.Enter) {
    // ...
  }

  if (e.key === keyCodes.a) {
    // ...
  }
};

Similar packages

Other packages similar to @fluentui/keyboard-keys

keycode

The 'keycode' package provides a simple utility for converting between keyboard key names and their key codes. It offers similar functionality to @fluentui/keyboard-keys by allowing developers to handle keyboard events more easily, but it focuses more on key code conversions rather than providing constants.

keyboardjs

The 'keyboardjs' package is a robust library for handling keyboard events. It offers more advanced features compared to @fluentui/keyboard-keys, such as key combinations, sequences, and context-specific bindings. It is suitable for applications that require complex keyboard interactions.

mousetrap

The 'mousetrap' package is a lightweight library for handling keyboard shortcuts. It provides functionality similar to @fluentui/keyboard-keys but focuses on defining and managing keyboard shortcuts in a more user-friendly way. It is ideal for applications that need to support a variety of keyboard shortcuts.