obsidian-sample-plugin/node_modules/w3c-keyname
naive231 5cb4dbfd1a Recompile 'main.ts'.
Add 'node_modules' to repo.
Remove essential, runtime environment files from ignoring list.
2024-11-21 18:49:58 +08:00
..
.tern-port Recompile 'main.ts'. 2024-11-21 18:49:58 +08:00
LICENSE Recompile 'main.ts'. 2024-11-21 18:49:58 +08:00
README.md Recompile 'main.ts'. 2024-11-21 18:49:58 +08:00
index.cjs Recompile 'main.ts'. 2024-11-21 18:49:58 +08:00
index.d.cts Recompile 'main.ts'. 2024-11-21 18:49:58 +08:00
index.d.ts Recompile 'main.ts'. 2024-11-21 18:49:58 +08:00
index.js Recompile 'main.ts'. 2024-11-21 18:49:58 +08:00
package.json Recompile 'main.ts'. 2024-11-21 18:49:58 +08:00

README.md

W3C keyname

Tiny library that exports a function keyName that takes a keyboard event and returns a KeyboardEvent.key-style string. Will use the actual key property of the event if available, and fall back to a value synthesized from the keyCode otherwise.

Probably often wrong on non-US keyboards, since the correspondence between a key code and the character it produces when shift is held is predicted based on a hard-coded table. Meant as a fallback for KeyboardEvent.key, not a replacement.

The lookup tables from key codes (event.keyCode) to names are exported as base (when Shift isn't held) and shift (when Shift is held).

License: MIT