Kbd
A keyboard key or shortcut, shown as text.
In Dense data
See it live
Start Storybook to see it live:
npm run storybookWhen to use it
In Dense data: Shows the shortcuts experts learn.
- Use it when: Telling people the shortcut for an action.
- Not when: Decoration, or the only way to discover an action.
Instead:
- Command: Where shortcuts are often listed.
Words
- Lead with the object, then the state: "Alert 2041 contained."
- Use numbers, not words for numbers.
- One verb per button. No "please", no exclamation marks.
- Use: Investigate, Filter, Assign, Escalated, Resolved. Avoid: Oops, Awesome, Please, Simply.
The labels components use, from the voice tokens:
content.action.commit: Savecontent.action.cancel: Cancelcontent.action.destroy: Deletecontent.action.retry: Retrycontent.action.empty-action: Change filters
See Voice and tone for the whole voice.
Use it in code
npx open-ds add kbd
The component reads only component keys and semantic tokens, so it follows the brand and mode on <html>.
Tokens it reads
Kbd reads 10 tokens of its own, each an alias of a semantic token. Each row is one part: its own token, the semantic it aliases, and the value it ends at. Change a semantic and every component that reads it follows; override one of Kbd's tokens to change Kbd alone.
Changes with theme
Dense data decides what changes when you switch theme. Here a switch changes colors only, so the marked rows differ between light and dark; everything else holds steady.
| Part | Its token and the semantic it aliases | Value |
|---|---|---|
| Kbd | ||
| Gap | component.kbd.gapspace.gap.tightvar(--kbd-gap) | space.4:0.25rem |
| Corner | component.kbd.radiusradius.badgevar(--kbd-radius) | radius.0:0rem |
| Fill Changes with theme | component.kbd.backgroundcolor.surface.sunkenvar(--kbd-background) | Lightslate.light.100:#EEF1F5Darkslate.dark.100:#262D38 |
| Padding, left and right | component.kbd.padding-xcomponent-spacing-map.x1var(--kbd-padding-x) | space.4:0.25rem |
| Text size | component.kbd.font-sizetype.caption.font-sizevar(--kbd-font-size) | font.size.12:0.75rem |
| Weight | component.kbd.font-weighttype.label.font-weightvar(--kbd-font-weight) | font.weight.500:500 |
| Text Changes with theme | component.kbd.labelcolor.text.mutedvar(--kbd-label) | Lightslate.light.600:#535D6DDarkslate.dark.400:#969FAD |
| Background 2 Changes with theme | component.kbd.background-2color.surface.canvasvar(--kbd-background-2) | Lightslate.light.50:#F7F8FADarkslate.dark.0:#0D1117 |
| Label 2 Changes with theme | component.kbd.label-2color.surface.canvasvar(--kbd-label-2) | Lightslate.light.50:#F7F8FADarkslate.dark.0:#0D1117 |
| Group | ||
| Gap | component.kbd.group.gapspace.gap.tightvar(--kbd-group-gap) | space.4:0.25rem |