Skip to main content

Combo Configuration

See the Combos informational page for more details and examples.

See Configuration Overview for instructions on how to change these settings.

Kconfig

Definition file: zmk/app/Kconfig

ConfigTypeDescriptionDefault
CONFIG_ZMK_COMBO_MAX_PRESSED_COMBOSintMaximum number of combos that can be active at the same time4

Devicetree

Applies to: compatible = "zmk,combos"

Definition file: zmk/app/dts/bindings/zmk,combos.yaml

The zmk,combos node itself has no properties. It should have one child node per combo.

Each child node can have the following properties:

PropertyTypeDescriptionDefault
bindingsphandle-arrayA behavior to run when the combo is triggered
key-positionsarrayA list of key position indices for the keys which should trigger the combo
timeout-msintAll the keys in key-positions must be pressed within this time in milliseconds to trigger the combo50
require-prior-idle-msintIf any non-modifier key is pressed within require-prior-idle-ms before a key in the combo, the key will not be considered for the combo-1 (disabled)
slow-releaseboolReleases the combo when all keys are released instead of when any key is releasedfalse
layersarrayA list of layers on which the combo may be triggered. Omission of this property allows all layers.