kbd-txt
A lightweight (~850 B) library for easy mac/window shortcut notation.
kbd-txt convert shortcut text depending on the type of OS (window/linux/mac).
Installation
# npm
npm install --save kbd-txt
# yarn
yarn add kbd-txt
Quick Usage
import { convert } from 'kbd-txt';
// Basic Usage
convert('Alt+S');
// Results
// mac: Option+S
// window: Alt+S
// Basic Usage 2 - $mod
convert('$mod+s');
// Results
// mac: Command+S
// window: Ctrl+S
// Symbol Usage
const options = { normalizeOptions: { useSymbol: true } };
convert('$mod+s', options);
// Results
// mac: ⌘+S
// window: Ctrl+S
Supported Keys
kbd-txt understands the following modifiers:
Meta: ['command', 'cmd', '⌘'],
Alt: ['alt', 'option', '⌥'],
Control: ['control', 'ctrl', '^'],
Shift: ['shift'],
API REFERENCE
convert
Convert shortcut text depending on the type of OS (window/linux/mac).
const options = { normalizeOptions: { useSymbol: true } };
convert('$mod+s', options);
// Results
// mac: ⌘+S
// window: Ctrl+S
Options
parseOptions: {
separator?: string; // A string that identifies characters to use in separating the string.
}
normalizeOptions: {
separator?: string; // A string used to separate one element of the array from the next in the resulting string.
useSymbol?: boolean; // If true, Display as a symbol.
}
parseToToken
Parse the shortcut text and convert to Token(KeyboardEvent.key) format.
It's the same form as the Keyboard Event.key.
$mod is converted to Meta/Control depending on the type of OS.
parseToToken('$mod+S');
// Results
// mac: ['Meta', 's']
// window: ['Control', 's']
Options
separator?: string; // A string that identifies characters to use in separating the string.
normalizeToken
Merge Token[] to text according to the option.
normalizeToken(['Alt', 's']);
// Results
// mac: Option+S
// window: Alt+S
Options
separator?: string; // A string used to separate one element of the array from the next in the resulting string.
useSymbol?: boolean; // If true, Display as a symbol.
How it works
Shortcut Text --(parse)--> Token(KeyboardEvent.key) --(normalize)--> Shortcuts Text for OS
parse: Parse the shortcut text and convert to Token(KeyboardEvent.key) format
normalize: Merge Token[] to text according to the option
Roadmaps
- Demo Site
- CDN version
- Option to view OS version as fixed (View only in Mac version, view only in Window version)
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
Distributed under the MIT License. See LICENSE for more information.
9 Aug 10, 2022
43 Dec 9, 2022
5 Sep 15, 2022
4 Oct 25, 2022
14 Jan 2, 2023
8.7k Jan 9, 2023
367 Jan 4, 2023
3 May 18, 2022
4 May 3, 2022