Skip to content

Commit 3567978

Browse files
committed
feat(docs): Add locality warning for nested behaviors
1 parent 52c91a7 commit 3567978

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/docs/features/split-keyboards.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,7 @@ However, certain behaviors have "global" or "source" localities, where they can
6868

6969
### Global Locality Behaviors
7070

71-
These are behaviors that affect all keyboard parts, such as changing lighting effects.
72-
Currently these are the following behaviors:
71+
These are behaviors that affect all keyboard parts, such as changing lighting effects:
7372

7473
- [RGB underglow behaviors](../behaviors/underglow.md)
7574
- [Backlight behaviors](../behaviors/backlight.md)
@@ -78,10 +77,15 @@ Currently these are the following behaviors:
7877

7978
### Source Locality Behaviors
8079

81-
These behaviors only affect the keyboard part that they are invoked from, given that they were invoked from a plain behavior binding (i.e. not nested inside another behavior) on a keymap layer. These behaviors include:
80+
These behaviors only affect the keyboard part that they are invoked from:
8281

8382
- [Reset behaviors](../behaviors/reset.md)
8483

84+
:::warning[Nesting behaviors with locality]
85+
Currently there is [an issue](https://github.com/zmkfirmware/zmk/issues/1494) preventing both global and source locality behaviors from working as expected if they are invoked from another behavior, such as a hold-tap, tap dance or a mod-morph.
86+
For this reason it is recommended that these behaviors are placed directly on a keymap layer.
87+
:::
88+
8589
:::note[Peripheral invocation]
8690
The peripheral side of the keyboard has to be paired and connected to the central side in order to be able to activate these behaviors, even if it is possible to trigger the behavior using only keys on that side.
8791
This is because the key bindings are processed on the central side which would then instruct the peripheral side to run the behavior's effect.

0 commit comments

Comments
 (0)