summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPete Johanson <peter@peterjohanson.com>2020-08-07 16:29:52 -0400
committerPete Johanson <peter@peterjohanson.com>2020-08-07 16:29:52 -0400
commitdd8deceed02b9d439eca3bc10fdde5b5d0fb9c6e (patch)
tree6c6e3c3f7948fba9f428123c791221eb885fa02a /docs
parent3b841c65bb264ec4a512ac564a0c4d0daa636cee (diff)
Add basic layer behavior docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/behavior/layers.md41
-rw-r--r--docs/sidebars.js2
2 files changed, 42 insertions, 1 deletions
diff --git a/docs/docs/behavior/layers.md b/docs/docs/behavior/layers.md
new file mode 100644
index 0000000..2388caf
--- /dev/null
+++ b/docs/docs/behavior/layers.md
@@ -0,0 +1,41 @@
+---
+title: Layers
+---
+
+## Summary
+
+Often, you may want a certain key position to alter which layers are enabled, change the default layer, etc.
+Some of those behaviors are still in the works; the ones that are working now are documented here.
+
+## Defines To Refer To Layers
+
+When working with layers, you may have several different key positions with bindings that enable/disable those layers.
+To make it easier to refer to those layers in your key bindings, and to change which layers are where later, you can
+add a set of `#define`s at the top of your keymap file, and use those layer in your keymap.
+
+For example, if you have three layers, you can add the following to the top of your keymap:
+
+```
+#define DEFAULT 0
+#define LOWER 1
+#define RAISE 2
+```
+
+This allows you to use those defines, e.g. `LOWER` later in your keymap.
+
+## Momentary Layer
+
+The "momentary layer" behavior allows you to enable a layer while a certain key is pressed. Immediately upon
+activation of the key, the layer is enabled, and immediately open release of the key, the layer is disabled
+again.
+
+### Behavior Binding
+
+- Reference: `&mo`
+- Parameter: The layer number to enable/disable, e.g. `1`
+
+Example:
+
+```
+&mo LOWER
+```
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 43d4ea7..7b04864 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -7,7 +7,7 @@ module.exports = {
"feature/encoders",
"feature/underglow",
],
- Behaviors: ["behavior/key-press"],
+ Behaviors: ["behavior/key-press", "behavior/layers"],
Development: [
"dev-clean-room",
"dev-setup",