diff options
| author | Jacek Królikowski <nietaki@gmail.com> | 2025-12-04 13:15:43 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-12-04 12:15:43 +0000 |
| commit | d39015a4011e53612e117ac4091444bf67792105 (patch) | |
| tree | f3c559fdaf15491bb1ebc932758603df5096789d /docs | |
| parent | bf0b88c4234b9f2173da0730dba9176d9a6e9526 (diff) | |
[DOCS] Add `keycodes` to `info.json` docs. More precise matrix masking info (#25801)
Diffstat (limited to 'docs')
| -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. | |||
| 327 | * `scroll_lock` <Badge type="info">Pin</Badge> | 327 | * `scroll_lock` <Badge type="info">Pin</Badge> |
| 328 | * The GPIO pin connected to the Scroll Lock LED. | 328 | * The GPIO pin connected to the Scroll Lock LED. |
| 329 | 329 | ||
| 330 | ## (Custom) Keycodes {#keycodes} | ||
| 331 | |||
| 332 | Defines [custom keycodes](custom_quantum_functions#definining-a-new-keycode) for use within keymaps. | ||
| 333 | |||
| 334 | * `keycodes` <Badge type="info">Array: Object</Badge> | ||
| 335 | * A list of keycode objects. | ||
| 336 | * `key` <Badge type="info">String</Badge> <Badge>Required</Badge> | ||
| 337 | * The enum name of the custom keycode. | ||
| 338 | * Example: `LAYER_CHANGE_BEEP_ON` | ||
| 339 | * `label` <Badge type="info">String</Badge> | ||
| 340 | * A short description of the custom keycode. | ||
| 341 | * `aliases` <Badge type="info">Array: String</Badge> | ||
| 342 | * A list of shortened names for the custom keycode. | ||
| 343 | * Example: `["LCBON", "LCB_ON"]` | ||
| 344 | |||
| 330 | ## Layouts {#layouts} | 345 | ## Layouts {#layouts} |
| 331 | 346 | ||
| 332 | 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`. | 347 | 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. | |||
| 513 | * The amount of time to wait between row/col selection and col/row pin reading, in microseconds. | 528 | * The amount of time to wait between row/col selection and col/row pin reading, in microseconds. |
| 514 | * Default: `30` (30 µs) | 529 | * Default: `30` (30 µs) |
| 515 | * `masked` <Badge type="info">Boolean</Badge> | 530 | * `masked` <Badge type="info">Boolean</Badge> |
| 516 | * Whether configured intersections should be ignored. | 531 | * Whether unconfigured intersections should be ignored. |
| 517 | * Default: `false` | 532 | * Default: `false` |
| 518 | * `rows` <Badge type="info">Array: Pin</Badge> | 533 | * `rows` <Badge type="info">Array: Pin</Badge> |
| 519 | * A list of GPIO pins connected to the matrix rows. | 534 | * A list of GPIO pins connected to the matrix rows. |
