sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added more examples to the Stringy Keymaps docs

Browse Source 
Rearranged text

Removed blank lines

Fixed "string name" to "string"

Enclosed string in single qutoes
This commit is contained in:
Moritz John 2023-01-25 10:17:38 +01:00 committed by xs5871
parent d7e9cfbc5b
commit fa7d72b175
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/en/extension_stringy_keymaps.md
View File

@ -1,6 +1,7 @@
# Stringy Keymaps
Enables referring to keys by `'NAME'` rather than `KC.NAME`.
Enables referring to keys by `'NAME'` rather than `KC.NAME`.\
This extension allows for a seamless integration of both string-based key references and standard keycodes.
For example:
@ -13,6 +14,9 @@ from kmk.extensions.stringy_keymaps import StringyKeymaps
# Indexed
# keyboard.keymap = [[ KC['A'], KC['B'], KC['RESET'] ]]
# String names mixed with normal keycodes
# keyboard.keymap = [[ 'A' , KC.B, KC.RESET ]]
# String names
keyboard.keymap = [[ 'A' , 'B', 'RESET' ]]
@ -27,3 +31,5 @@ keyboard.extensions.append(stringyKeymaps)
It should be noted that these are **not** ASCII. The string is **not** what
will be sent to the computer. The examples above have no functional difference.
When utilizing layer keycodes, such as `KC.MO(layer)`, it's not possible to use a string like `'MO(layer)'` instead employ the standard notation of e.g. `KC.MO(1)` in your keymap.