kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Apply suggestions from code review

Browse source 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
This commit is contained in:
Nicolas Munnich 2024-07-25 21:05:07 +02:00 • committed by GitHub
parent e72254e5ef
commit c6a26cb9c7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docs/behaviors/layers.md
View file

@ -9,7 +9,7 @@ Often, you may want a certain key position to alter which layers are enabled, ch
Some of those behaviors are still in the works; the ones that are working now are documented here.
:::note
Activating a layer will not disable layers higher up in the "layer stack". See [Layers](../features/keymaps.mdx#layers) for more information.
Multiple layers can be active at the same time and activating a layer will not deactivate layers higher up in the "layer stack". See [Layers](../features/keymaps.mdx#layers) for more information.
:::
## Defines to Refer to Layers

8
docs/docs/features/keymaps.mdx
View file

@ -46,10 +46,12 @@ in ZMK contains a set of bindings that bind a certain behavior to a certain key
All layers are assigned and referred to by a natural number, with the base layer being layer `0`. It is common to [use the C preprocessor to "name" layers](../behaviors/layers.md#defines-to-refer-to-layers), making them more legible.
The default layer (usually the base layer) is always enabled. Certain bound behaviors may enable/disable additional layers.
The default layer (the base layer with index 0) is always enabled. Certain bound behaviors may enable/disable additional layers.
When a key location is pressed/released, the _highest-valued currently active_ layer is used. The press/release event is sent to the behavior bound at that position in said layer, for it to perform whatever actions it wants to in reaction to the event. The behavior can choose to "consume" the event, or "pass it along" and let the next highest-valued active layer _also_ get the event (whose behavior may continue "passing it along").
Note that the _activation_ order isn't relevant for determining the priority of active layers, it is determined _only_ by the definition order.
## Behavior Bindings
Binding a behavior at a certain key position may include up to two extra parameters that are used to
@ -132,7 +134,7 @@ Each layer of your keymap will be nested under the keymap node. Here is an examp
&kp A &kp B &kp C
>;
};
}
};
```
Each layer should have:
@ -149,7 +151,7 @@ Here is an example of a trio of layers for a simple 6-key macropad:
<KeymapExample />
:::note
Even if layer `1` was to be activated after `2`, layer `2` would still have priority as it is higher valued. Behaviors such as [`&to`](../behaviors/layers.md#to-layer) can be used to enable one layer _and disable all other non-default layers_, though.
Even if layer `1` was to be activated after `2`, layer `2` would still have priority as it is higher valued. Behaviors such as [To Layer (`&to`)](../behaviors/layers.md#to-layer) can be used to enable one layer _and disable all other non-default layers_, though.
:::
### Complete Example

2
docs/docs/keymap-example.md
View file

@ -29,7 +29,5 @@
&kp LCTRL &kp LALT &trans
>;
};
};
```