kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix(docs): Tweak overview of behaviors.

Browse source 
* New shield behavior docs are slightly out of date.
This commit is contained in:
Pete Johanson 2020-12-18 15:52:53 +00:00
parent 8fd9b619a7
commit 070028734c
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/docs/development/new-shield.md
View file

@ -364,11 +364,12 @@ The two `#include` lines at the top of the keymap are required in order to bring
### Keymap Behaviors ### Keymap Behaviors
Further documentation on behaviors and bindings is forthcoming, but a summary of the current behaviors you can bind to key positions is as follows: For full details on the available behaviors, refer to [Behaviors - Key Press](/docs/behaviors/key-press) and read from there. A quick summary of some available behaviors you can use:
- `kp` is the "key press" behavior, and takes a single binding argument of the key code from the 'keyboard/keypad" HID usage table. - `kp` is the "key press" behavior, and takes a single binding argument of the key code from the 'keyboard/keypad" HID usage table.
- `mo` is the "momentary layer" behaviour, and takes a single binding argument of the numeric ID of the layer to momentarily enable when that key is held. - `mo` is the "momentary layer" behaviour, and takes a single binding argument of the numeric ID of the layer to momentarily enable when that key is held.
- `trans` is the "transparent" behavior, useful to be place in higher layers above `mo` bindings to be sure the key release is handled by the lower layer. No binding arguments are required. - `trans` is the "transparent" behavior, useful to be place in higher layers above `mo` bindings to be sure the key release is handled by the lower layer. No binding arguments are required.
- `none` is the "none" behavior, useful to be place in higher layers above `mo` bindings to prevent the key position press/release being handled by the lower layer. No binding arguments are required.
- `mt` is the "mod-tap" behavior, and takes two binding arguments, the modifier to use if held, and the keycode to send if tapped. - `mt` is the "mod-tap" behavior, and takes two binding arguments, the modifier to use if held, and the keycode to send if tapped.
## Adding Features ## Adding Features