diff options
| author | Jacek Królikowski | 2025-12-04 13:15:43 +0100 |
|---|---|---|
| committer | GitHub | 2025-12-04 13:15:43 +0100 |
| commit | d39015a4011e53612e117ac4091444bf67792105 (patch) | |
| tree | f3c559fdaf15491bb1ebc932758603df5096789d | |
| parent | bf0b88c4234b9f2173da0730dba9176d9a6e9526 (diff) | |
[DOCS] Add `keycodes` to `info.json` docs. More precise matrix masking info (#25801)
| -rw-r--r-- | docs/reference_info_json.md | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md index 91ab7f4577..301e4b12dd 100644 --- a/docs/reference_info_json.md +++ b/docs/reference_info_json.md @@ -327,6 +327,21 @@ Configures the [LED Indicators](features/led_indicators) feature. * `scroll_lock` <Badge type="info">Pin</Badge> * The GPIO pin connected to the Scroll Lock LED. +## (Custom) Keycodes {#keycodes} + +Defines [custom keycodes](custom_quantum_functions#definining-a-new-keycode) for use within keymaps. + +* `keycodes` <Badge type="info">Array: Object</Badge> + * A list of keycode objects. + * `key` <Badge type="info">String</Badge> <Badge>Required</Badge> + * The enum name of the custom keycode. + * Example: `LAYER_CHANGE_BEEP_ON` + * `label` <Badge type="info">String</Badge> + * A short description of the custom keycode. + * `aliases` <Badge type="info">Array: String</Badge> + * A list of shortened names for the custom keycode. + * Example: `["LCBON", "LCB_ON"]` + ## Layouts {#layouts} The `layouts` portion of the dictionary contains several nested dictionaries. The outer layer consists of QMK layout names, for example `LAYOUT_60_ansi` or `LAYOUT_60_iso`. @@ -513,7 +528,7 @@ Configures the [LED Matrix](features/led_matrix) feature. * The amount of time to wait between row/col selection and col/row pin reading, in microseconds. * Default: `30` (30 µs) * `masked` <Badge type="info">Boolean</Badge> - * Whether configured intersections should be ignored. + * Whether unconfigured intersections should be ignored. * Default: `false` * `rows` <Badge type="info">Array: Pin</Badge> * A list of GPIO pins connected to the matrix rows. |