summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPete Johanson <peter@peterjohanson.com>2020-08-18 14:31:20 -0400
committerGitHub <noreply@github.com>2020-08-18 14:31:20 -0400
commitc054feb3c942b26bf0ddd0fc6e99ac8e3703e8d4 (patch)
treefc6e4cb070391573eb99f04898e35aa3de777785 /docs
parentc667be1404259851daca8719f08e1436b408fea9 (diff)
parent63e02d60dcfbf4e4d7f9954075d1e087f816944b (diff)
Merge pull request #100 from petejohanson/behaviors/add-none
Add `&none` behavior.
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/behavior/misc.md41
-rw-r--r--docs/sidebars.js1
2 files changed, 42 insertions, 0 deletions
diff --git a/docs/docs/behavior/misc.md b/docs/docs/behavior/misc.md
new file mode 100644
index 0000000..799c91c
--- /dev/null
+++ b/docs/docs/behavior/misc.md
@@ -0,0 +1,41 @@
+---
+title: Miscellaneous
+---
+
+## Summary
+
+There are a few miscellaneous behaviors that are helpful when working with layers in keymaps,
+in particular, with handling what happens in higher layers, and if events are passed to
+the next layer or not
+
+## Transparent
+
+The transparent behavior simply ignores key position presses/releases, so they will be
+passed down to the next active layer in the stack.
+
+### Behavior Binding
+
+- Reference: `&trans`
+- Parameters: None
+
+Example:
+
+```
+&trans
+```
+
+## None
+
+The none behavior simply swallows and stops key position presses/releases, so they will **not**
+be passed down to the next active layer in the stack.
+
+### Behavior Binding
+
+- Reference: `&none`
+- Parameters: None
+
+Example:
+
+```
+&none
+```
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 1bd0358..90bdfa2 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -10,6 +10,7 @@ module.exports = {
Behaviors: [
"behavior/key-press",
"behavior/layers",
+ "behavior/misc",
"behavior/lighting",
],
Development: [