Skip to content

Commit f2d8b9b

Browse files
huber-thcaksoylar
huber-th
and
caksoylar
committed
feat(docs): Add Behavior overview page
Co-authored-by: Cem Aksoylar <[email protected]>
1 parent 4435879 commit f2d8b9b

File tree

2 files changed

+83
-0
lines changed

2 files changed

+83
-0
lines changed

‎docs/docs/behaviors/index.mdx

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: Behavior Overview
3+
sidebar_label: Overview
4+
---
5+
6+
# Behaviors Overview
7+
8+
"Behaviors" are bindings that are assigned to and triggered by key positions on keymap layers, sensors (like an encoder) or combos. They describe what happens e.g. when a certain key position is pressed or released, or an encoder triggers a rotation event. They can also be recursively invoked by other behaviors, such as macros.
9+
10+
Below is a summary of pre-defined behavior bindings and user-definable behaviors available in ZMK, with references to documentation pages describing them.
11+
12+
## Key press behaviors
13+
14+
| Binding | Behavior | Description |
15+
| ------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
16+
| `&kp` | [Key Press](key-press.md) | Send keycodes to the connected host when a key is pressed |
17+
| `&mt` | [Mod Tap](mod-tap.md) | Sends a different key press depending on whether a key is held or tapped |
18+
| `&kt` | [Key Toggle](key-toggle.md) | Toggles the press of a key. If the key is not currently pressed, key toggle will press it, holding it until the key toggle is pressed again or the key is released in some other way. If the key is currently pressed, key toggle will release it |
19+
| `&sk` | [Sticky Key](sticky-key.md) | Stays pressed until another key is pressed, then is released. It is often used for modifier keys like shift, which allows typing capital letters without holding it down |
20+
| `&gresc` | [Grave Escape](mod-morph.md#behavior-binding) | Sends Grave Accent `` ` `` keycode if shift or GUI is held, sends Escape keycode otherwise |
21+
| `&caps_word` | [Caps Word](caps-word.md) | Behaves similar to caps lock, but automatically deactivates when any key not in a continue list is pressed, or if the caps word key is pressed again |
22+
| `&key_repeat` | [Key Repeat](key-repeat.md) | Sends again whatever keycode was last sent |
23+
24+
## Miscellaneous behaviors
25+
26+
| Binding | Behavior | Description |
27+
| -------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
28+
| `&trans` | [Transparent](misc.md#transparent) | Passes the key press down to the next active layer in the stack for processing |
29+
| `&none` | [None](misc.md#none) | Swallows and stops the key press, no keycode will be sent nor will the key press be passed down to the next active layer in the stack |
30+
31+
## Layer navigation behaviors
32+
33+
| Binding | Behavior | Description |
34+
| ------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
35+
| `&mo` | [Momentary Layer](layers.md#momentary-layer) | Enables a layer while a key is pressed |
36+
| `&lt` | [Layer-tap](layers.md#layer-tap) | Enables a layer when a key is held, and outputs a key press when the key is only tapped for a short time |
37+
| `&to` | [To Layer](layers.md#to-layer) | Enables a layer and disables all other layers except the default layer |
38+
| `&tog` | [Toggle Layer](layers.md#toggle-layer) | Enables a layer until the layer is manually disabled |
39+
| `&sl` | [Sticky Layer](sticky-layer.md) | Activates a layer until another key is pressed, then deactivates it |
40+
41+
## Mouse emulation behaviors
42+
43+
| Binding | Behavior | Description |
44+
| ------- | ----------------------------------------------------------- | ------------------------------- |
45+
| `&mkp` | [Mouse Button Press](mouse-emulation.md#mouse-button-press) | Emulates pressing mouse buttons |
46+
47+
## Reset behaviors
48+
49+
| Binding | Behavior | Description |
50+
| ------------- | --------------------------------- | ---------------------------------------------------------------------------------------- |
51+
| `&sys_reset` | [Reset](reset.md#reset) | Resets the keyboard and re-runs the firmware flashed to the device |
52+
| `&bootloader` | [Bootloader](reset.md#bootloader) | Resets the keyboard and puts it into bootloader mode, allowing you to flash new firmware |
53+
54+
## Output selection behaviors
55+
56+
| Binding | Behavior | Description |
57+
| ------- | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
58+
| `&bt` | [Bluetooth](bluetooth.md#bluetooth-behavior) | Completes a bluetooth action given on press, for example switching between devices |
59+
| `&out` | [Output Selection](outputs.md#output-selection-behavior) | Allows selecting whether output is sent to the USB or bluetooth connection when both are connected |
60+
61+
## Lighting behaviors
62+
63+
| Binding | Behavior | Description |
64+
| --------- | ---------------------------------------------- | ---------------------------------------------------------------------------- |
65+
| `&rgb_ug` | [RGB Underglow](underglow.md#behavior-binding) | Controls the RGB underglow, usually placed underneath the keyboard |
66+
| `&bl` | [Backlight](backlight.md#behavior-binding) | Controls the keyboard backlighting, usually placed through or under switches |
67+
68+
## Power management behaviors
69+
70+
| Binding | Behavior | Description |
71+
| ------------ | --------------------------------------------- | --------------------------------------------------------------- |
72+
| `&ext_power` | [Power management](power.md#behavior-binding) | Allows enabling or disabling the VCC power output to save power |
73+
74+
## User-defined behaviors
75+
76+
| Behavior | Description |
77+
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
78+
| [Macros](macros.md) | Allows configuring a list of other behaviors to invoke when the key is pressed and/or released |
79+
| [Hold-Tap](hold-tap.mdx) | Invokes different behaviors depending on key press duration or interrupting keys. This is the basis for [layer-tap](layers.md#layer-tap) and [mod-tap](mod-tap.md) |
80+
| [Tap Dance](tap-dance.mdx) | Invokes different behaviors corresponding to how many times a key is pressed |
81+
| [Mod-Morph](mod-morph.md) | Invokes different behaviors depending on whether a specified modifier is held during a key press |
82+
| [Sensor Rotation](sensor-rotate.md) | Invokes different behaviors depending on whether a sensor is rotated clockwise or counter-clockwise |

‎docs/sidebars.js

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ module.exports = {
2222
"features/beta-testing",
2323
],
2424
Behaviors: [
25+
"behaviors/index",
2526
"behaviors/key-press",
2627
"behaviors/layers",
2728
"behaviors/misc",

0 commit comments

Comments
 (0)