Skip to content

Commit

Permalink
fix: update combo spec
Browse files Browse the repository at this point in the history
  • Loading branch information
@englmaxi
englmaxi committed Feb 26, 2024
1 parent 915abed commit e4cda0e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion KEYMAP_SPEC.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down

0 comments on commit e4cda0e

Please sign in to comment.