From e4cda0ead0fdc13e935f37cb37ab2cb04536252e Mon Sep 17 00:00:00 2001 From: Maximilian Engl Date: Mon, 26 Feb 2024 18:45:35 +0100 Subject: [PATCH] fix: update combo spec --- KEYMAP_SPEC.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/KEYMAP_SPEC.md b/KEYMAP_SPEC.md index 8061283..b326483 100644 --- a/KEYMAP_SPEC.md +++ b/KEYMAP_SPEC.md @@ -130,7 +130,7 @@ This is an optional field that contains a list of `ComboSpec`s, each of which is | field name (alias) | type | default value | description | | ------------------- | ------------------------------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `key_positions (p)` | `list[int]` | required | list of key indices that trigger the combo[^4] | -| `key (k)` | `LayoutKey`[^5] | required | key produced by the combo when triggered, `type` field will be ignored | +| `key (k)` | `LayoutKey`[^5] | required | key produced by the combo when triggered, `LayoutKey`'s `type` field will be merged with type field of `ComboSpec` | | `layers (l)` | `list[str]` | `[]`[^6] | list of layers the combo can trigger on, specified using layer names in `layers` field | | `align (a)` | `"mid" \| "top" \| "bottom" \| "left" \| "right"` | `"mid"` | where to draw the combo: `mid` draws on the mid-point of triggering keys' center coordinates, or to the `top`/`bottom`/`left`/`right` of the triggering keys | | `offset (o)` | `float` | `0.0` | additional offset to `top`/`bottom`/`left`/`right` positioning, specified in units of key width/height: useful for combos that would otherwise overlap |