Keyboard Shortcut Block
Document keyboard shortcuts with styled key caps. Display key combinations alongside their descriptions in a clean, scannable format.
The Keyboard Shortcut block displays key combinations in a styled format that resembles physical keyboard keys. This makes shortcut documentation easy to scan and reference.
When to Use
Block Properties
| Property | Required | Description |
|---|---|---|
| Title | No | Optional heading for the shortcut group |
| Shortcuts | Yes | Array of key-description pairs |
Shortcut Properties
| Property | Required | Description |
|---|---|---|
| Keys | Yes | Key combination as an array (e.g., ["Ctrl", "S"]) |
| Description | Yes | What the shortcut does |
Example: Editor Shortcuts
Common shortcuts for text editing.
Example: Navigation Shortcuts
Shortcuts without a title heading.
Editing Shortcuts
| Action | How To |
|---|---|
| Add Title | Enter an optional title in the title field |
| Enter Keys | Type combinations like Ctrl + Shift + P in the keys field |
| Add Description | Enter what the shortcut does in the description field |
| Add Shortcut | Click Add Shortcut button for new entries |
| Preview | View styled key caps in the live preview |