Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion src/content/docs/style-guide/formatting/keyboard-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,24 @@ title: Keyboard keys

---

Use *select* instead of *click* when directing users to choose or select objects, commands, or options. Use *press* only when referring to pressing keys on a keyboard.
## Wording

- Use **select** instead of **click** when directing users to choose or select objects, commands, or options.
- Use **press** only when referring to pressing keys on a keyboard.

## Formatting keyboard shortcuts

When telling readers what keyboard shortcuts to use to achieve a result:
- Place the keyboard shortcut in between backticks (monospace formatting)
- Use uppercase letters with the abbreviated version of the key (`CTRL` instead of `CONTROL`, `CMD` instead of `COMMAND`for example)
- Wrap the complete keyboard shortcut in between backticks, including the plus sign:
- **Do**:
```mdx
`CTRL + C`
```

- **Don't**:
```mdx
`CTRL` + `C`
```
- Do not use the old `<kbd></kbd>` component
Loading