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

feat(docs): Add locality warning for nested behaviors

Browse source
This commit is contained in:
Cem Aksoylar 2024-08-06 17:21:53 -07:00
parent 2501f1f548
commit 2a0708d1fc
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/docs/features/split-keyboards.md
View file

@ -68,8 +68,7 @@ However, certain behaviors have "global" or "source" localities, where they can
### Global Locality Behaviors
These are behaviors that affect all keyboard parts, such as changing lighting effects.
Currently these are the following behaviors:
These are behaviors that affect all keyboard parts, such as changing lighting effects:
- [RGB underglow behaviors](../behaviors/underglow.md)
- [Backlight behaviors](../behaviors/backlight.md)
@ -78,10 +77,15 @@ Currently these are the following behaviors:
### Source Locality Behaviors
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:
These behaviors only affect the keyboard part that they are invoked from:
- [Reset behaviors](../behaviors/reset.md)
:::warning[Nesting behaviors with locality]
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.
For this reason it is recommended that these behaviors are placed directly on a keymap layer.
:::
:::note[Peripheral invocation]
Peripherals must be paired and connected to the central in order to be able to activate these behaviors, even if it is possible to trigger the behavior using only keys on a particular peripheral.
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.