summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPete Johanson <peter@peterjohanson.com>2020-08-18 14:25:03 -0400
committerGitHub <noreply@github.com>2020-08-18 14:25:03 -0400
commitc667be1404259851daca8719f08e1436b408fea9 (patch)
treefb191880ae293324da190b7aaf89b1c3917b92ff /docs
parent2ffe09b617419a25e45c387e001ea59d3cbb5652 (diff)
parent50643b2c561ef58d4c96e7dba6c55c0ef291146a (diff)
Merge pull request #98 from BrainWart/layer-toggle
Feature: Layer toggle
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/behavior/layers.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/docs/behavior/layers.md b/docs/docs/behavior/layers.md
index 2388caf..3e520ca 100644
--- a/docs/docs/behavior/layers.md
+++ b/docs/docs/behavior/layers.md
@@ -39,3 +39,54 @@ Example:
```
&mo LOWER
```
+
+## Toggle Layer
+
+The "toggle layer" behavior allows you to enable a layer until the layer is manually disabled.
+
+### Behavior Binding
+
+- Reference: `&tog`
+- Parameter: The layer number to enable/disable, e.g. `1`
+
+Example:
+
+```
+&tog LOWER
+```
+
+"Toggle layer" for a :
+```
+#define DEFAULT 0
+#define NAVI 1
+
+#define NONE 0
+
+/ {
+ keymap {
+ compatible = "zmk,keymap";
+
+ default_layer {
+ bindings = <
+ &tog NAVI &kp KDIV &kp KMLT &kp KMIN
+ &kp NUM_7 &kp NUM_8 &kp NUM_9 &kp KPLS
+ &kp NUM_4 &kp NUM_5 &kp NUM_6 &kp KPLS
+ &kp NUM_1 &kp NUM_2 &kp NUM_3 &kp RET
+ &kp NUM_0 &kp NUM_0 &kp DOT &kp RET
+ >;
+ };
+
+ nav_layer {
+ bindings = <
+ &tog NAVI &kp KDIV &kp KMLT &kp KMIN
+ &kp HOME &kp UARW &kp PGUP &kp KPLS
+ &kp LARW &none &kp RARW &kp KPLS
+ &kp END &kp DARW &kp PGDN &kp RET
+ &kp INS &kp INS &kp DEL &kp RET
+ >;
+ };
+ };
+};
+```
+
+It is possible to use "toggle layer" to have keys that raise and lower the layers as well. \ No newline at end of file