Browse Source

fix(docs) omit layers -1 example, clarify it defaults when omitted (#757)

* fix(docs) omit layers -1 example, clarify

* comment, simplify description

* remove 'the'
xmkb
Michael van Eerd 4 years ago committed by GitHub
parent
commit
fadb508671
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 3
      docs/docs/features/combos.md

3
docs/docs/features/combos.md

@ -18,7 +18,6 @@ Combos configured in your `.keymap` file, but are separate from the `keymap` nod
timeout-ms = <50>; timeout-ms = <50>;
key-positions = <0 1>; key-positions = <0 1>;
bindings = <&kp ESC>; bindings = <&kp ESC>;
layers = <-1>;
}; };
}; };
}; };
@ -28,7 +27,7 @@ Combos configured in your `.keymap` file, but are separate from the `keymap` nod
- The `compatible` property should always be `"zmk,combos"` for combos. - The `compatible` property should always be `"zmk,combos"` for combos.
- `timeout-ms` is the number of milliseconds that all keys of the combo must be pressed. - `timeout-ms` is the number of milliseconds that all keys of the combo must be pressed.
- `key-positions` is an array of key positions. See the info section below about how to figure out the positions on your board. - `key-positions` is an array of key positions. See the info section below about how to figure out the positions on your board.
- `layers = <0 1...>` will allow limiting a combo to specific layers. this is an _optional_ parameter and defaults to `-1` which is global scope. - `layers = <0 1...>` will allow limiting a combo to specific layers. This is an _optional_ parameter, when omitted it defaults to global scope.
- `bindings` is the behavior that is activated when the behavior is pressed. - `bindings` is the behavior that is activated when the behavior is pressed.
- (advanced) you can specify `slow-release` if you want the combo binding to be released when all key-positions are released. The default is to release the combo as soon as any of the keys in the combo is released. - (advanced) you can specify `slow-release` if you want the combo binding to be released when all key-positions are released. The default is to release the combo as soon as any of the keys in the combo is released.

Loading…
Cancel
Save