# Supported Keys Reference

This document lists all keys supported by OverKeys for use in custom layouts. Use these key names or their alias when defining your keyboard layouts in the configuration file.

## Alphabetic Keys

| Key       | Description                  |
| --------- | ---------------------------- |
| `A` - `Z` | Standard Latin alphabet keys |

## Numeric Keys

| Key | Description |
| --- | ----------- |
| `0` | Number 0    |
| `1` | Number 1    |
| `2` | Number 2    |
| `3` | Number 3    |
| `4` | Number 4    |
| `5` | Number 5    |
| `6` | Number 6    |
| `7` | Number 7    |
| `8` | Number 8    |
| `9` | Number 9    |

## Function Keys

| Key          |
| ------------ |
| `F1` - `F24` |

## Navigation Keys

| Key        | Aliases                |
| ---------- | ---------------------- |
| `Left`     | `LEFT`, `←`, `◄`, `◀`  |
| `Right`    | `RIGHT`, `→`, `►`, `▶` |
| `Up`       | `UP`, `↑`, `▲`         |
| `Down`     | `DOWN`, `↓`, `▼`       |
| `Home`     | `HOME`, `⇱`, `⇤`, `↖`  |
| `End`      | `END`, `⇲`, `⇥`, `↘`   |
| `PageUp`   | `PGUP`, `⤒`, `⇞`       |
| `PageDown` | `PGDN`, `⤓`, `⇟`       |

## Editing Keys

| Key         | Aliases                                              |
| ----------- | ---------------------------------------------------- |
| `Backspace` | `BSPC`, `BS`, `BKSP`, `BKS`, `⌫`, `␈`                |
| `Enter`     | `ENT`, `RETURN`, `RET`, `⏎`, `↵`, `↩`, `⌤`, `␤`      |
| `Tab`       | `TAB`, `⭾`, `↹`                                      |
| `Space`     | ` ` (space character), `␣`, `⎵`, `␠`, `SPC`, `SPACE` |
| `Delete`    | `DEL`, `DELETE`, `⌦`, `␡`                            |
| `Insert`    | `INS`, `INSERT`, `⎀`                                 |
| `Escape`    | `ESC`, `⎋`                                           |

## Modifier Keys

| Key        | Aliases                                                             |
| ---------- | ------------------------------------------------------------------- |
| `LShift`   | `Shift`,`SFT`, `SHFT`, `SHIFT`, `⇧`,`LSFT`, `LSHFT`, `LSHIFT`, `‹⇧` |
| `RShift`   | `RSFT`, `RSHFT`, `RSHIFT`, `⇧›`                                     |
| `LControl` | `Control`,`CTL`, `CTRL`, `⌃`, `⎈`,`LCTL`, `LCTRL`, `‹⌃`, `‹⎈`       |
| `RControl` | `RCTL`, `RCTRL`, `⌃›`, `⎈›`                                         |
| `LAlt`     | `Alt`,`ALT`, `⌥`, `⎇`,`LALT`, `‹⎇`, `‹⌥`                            |
| `RAlt`     | `RALT`, `⎇›`, `⌥›`                                                  |
| `Win`      | `WIN`, `⌘`, `⊞`, `◆`, `❖`                                           |

## Lock Keys

| Key          | Aliases                 |
| ------------ | ----------------------- |
| `CapsLock`   | `CAPS`, `⇪`             |
| `NumLock`    | `NLK`, `NLCK`, `⇭`      |
| `ScrollLock` | `SLCK`, `SCRLCK`, `⇳🔒` |

## Numpad Keys

<!-- Numpad keys share state with regular keys -->

| Key | Alias  |
| --- | ------ |
| `0` | `🔢₀`  |
| `1` | `🔢₁`  |
| `2` | `🔢₂`  |
| `3` | `🔢₃`  |
| `4` | `🔢₄`  |
| `5` | `🔢₅`  |
| `6` | `🔢₆`  |
| `7` | `🔢₇`  |
| `8` | `🔢₈`  |
| `9` | `🔢₉`  |
| `*` | `🔢∗`  |
| `+` | `🔢₊`  |
| `-` | `🔢₋`  |
| `.` | `🔢．` |
| `/` | `🔢⁄`  |

## Punctuation and Symbol Keys

| Key     | Description       |
| ------- | ----------------- |
| `,`     | Comma             |
| `<`     | Less Than         |
| `.`     | Period            |
| `>`     | Greater Than      |
| `;`     | Semicolon         |
| `:`     | Colon             |
| `/`     | Slash             |
| `?`     | Question Mark     |
| `[`     | Left Bracket      |
| `{`     | Left Brace        |
| `]`     | Right Bracket     |
| `}`     | Right Brace       |
| `\\`    | Backslash         |
| `\|`    | Pipe              |
| `` ` `` | Backtick          |
| `~`     | Tilde             |
| `'`     | Apostrophe        |
| `"`     | Quote             |
| `=`     | Equals            |
| `+`     | Plus              |
| `-`     | Hyphen            |
| `_`     | Underscore        |
| `!`     | Exclamation Mark  |
| `@`     | At Symbol         |
| `#`     | Hash/Pound        |
| `$`     | Dollar Sign       |
| `%`     | Percent           |
| `^`     | Caret             |
| `&`     | Ampersand         |
| `*`     | Asterisk          |
| `(`     | Left Parenthesis  |
| `)`     | Right Parenthesis |

## Implementation Notes

1. For now, modifier keys default to their left-side versions. For example, using `SHIFT` will only be triggered by the Left Shift key.
2. When using the space character `" "` in your layout, be aware that it will inherit all the properties of the spacebar including its width and having the layout name printed on it. If you want to avoid this behavior, use one of the alternative aliases like `Space`, `SPACE`, `SPC`, `␠`, `␣`, `⎵`, instead.
3. Locale-specific keys are supported starting from v0.3.2. Refer to the [Locales](../advanced/locales.md) documentation instead.