@fluentui/keyboard-key

v0.4.23

A simple utility for determining the KeyboardEvent.key property from a keyboard event. For more information about how to use this package see README

Latest version published 5 months ago

License: MIT

NPM

GitHub

Package Health Score

85 / 100

security
No known security issues
popularity
Popular
maintenance
Sustainable
community
Active

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.4.23	\|	06/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.5	\|	11/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.17	\|	04/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.7	\|	05/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (85,776)

GitHub Stars: 18.47K
Forks: 2.73K
Contributors: 390

Direct Usage Popularity

The npm package @fluentui/keyboard-key receives a total of 85,776 downloads a week. As such, we scored @fluentui/keyboard-key popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @fluentui/keyboard-key, we found that it has been starred 18,467 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 390
Funding: No

A good and healthy external contribution signal for @fluentui/keyboard-key project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 438
Open PR: 147
Last Release: 5 months ago
Last Commit: 10 days ago

Further analysis of the maintenance status of @fluentui/keyboard-key based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that @fluentui/keyboard-key demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 1 Direct
Versions: 57
Install Size: 144 kB
Dist-tags: 1
# of Files: 28
Maintainers: 12
TS Typings: Yes

@fluentui/keyboard-key has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

@fluentui/keyboard-key

A simple utility for determining the KeyboardEvent.key property from a keyboard event.

Install

yarn add keyboard-key

# or

npm install keyboard-key

Usage

getKey()

Get the key property value from an event.

document.addEventListener('keydown', event =&gt; {
  const key = keyboardKey.getKey(event);

  switch (key) {
    case 'Escape':
      // handle escape key
      break;
    default:
      break;
  }
});

> See MDN or the source for a full list of key values.

getCode()

You can also get the normalized keyCode from an event. @fluentui/keyboard-key includes a hash of key names to keyCodes for easy comparisons:

document.addEventListener('keydown', event =&gt; {
  const code = getCode(event);

  switch (code) {
    case keyboardKey.Escape: // 27
      // handle escape key
      break;
    default:
      break;
  }
});

Why?

Most previous key identifying KeyboardEvent properties have been pressed have been deprecated in favor of Keyboard.key.

👎 KeyboardEvent.char 👎 KeyboardEvent.charCode 👎 KeyboardEvent.keyCode 👎 KeyboardEvent.keyIdentifier 👎 KeyboardEvent.keyLocation 👎 KeyboardEvent.which

👍 KeyboardEvent.key

Unfortunately, KeyboardEvent.key does not yet have full browser support. Leaving the browsers without a reliable property for identifying keyboard event keys.

Locale Caveat

This utility interprets use of the shift key when inferring event key values. Example, an event describing shift+/ would result in a key value of ?. This logic assumes an en-US locale keyboard layout. This will not work if you are using a different locale such as a German layout where / is shift+7.

@fluentui/keyboard-key dependencies

tslib

@fluentui/keyboard-key development dependencies

@fluentui/eslint-plugin @fluentui/scripts-api-extractor @fluentui/scripts-jest @fluentui/scripts-tasks

FAQs

What is @fluentui/keyboard-key?

A simple utility for determining the KeyboardEvent.key property from a keyboard event. Visit Snyk Advisor to see a full health score report for @fluentui/keyboard-key, including popularity, security, maintenance & community analysis.

Is @fluentui/keyboard-key popular?

The npm package @fluentui/keyboard-key receives a total of 85,776 weekly downloads. As such, @fluentui/keyboard-key popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @fluentui/keyboard-key well maintained?

We found indications that @fluentui/keyboard-key maintenance is sustainable demonstrating some project activity. We saw a total of 390 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @fluentui/keyboard-key safe to use?

The npm package @fluentui/keyboard-key was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 8 November-2024, at 01:58 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (85,776)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@fluentui/keyboard-key

Install

Usage

getKey()

getCode()

Why?

Locale Caveat

@fluentui/keyboard-key dependencies

@fluentui/keyboard-key development dependencies

FAQs

What is @fluentui/keyboard-key?

Is @fluentui/keyboard-key popular?

Is @fluentui/keyboard-key well maintained?

Is @fluentui/keyboard-key safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues