Design Token Cheat Sheet
Design Token Cheat Sheet
A design token cheat sheet provides quick reference for common token tasks, syntax, and patterns. Unlike comprehensive documentation, cheat sheets offer scannable information for developers and designers who know the basics but need quick reminders. Effective cheat sheets become frequently-referenced resources that speed up daily work.
What Is a Design Token Cheat Sheet
A design token cheat sheet is a condensed reference document covering the most common token operations, syntax patterns, and quick solutions. It prioritizes speed of access over comprehensive explanation, serving users who need immediate answers.
Cheat sheets complement detailed documentation by providing fast lookups for routine tasks.
How Design Token Cheat Sheets Work
CSS Usage:
/* Using a token */
.element {
color: var(--color-text-primary);
}
/* With fallback */
.element {
color: var(--color-text-primary, #171717);
}
/* Combining tokens */
.element {
padding: var(--spacing-sm) var(--spacing-md);
}
Token Reference Syntax:
/* Direct value */
{ "$value": "#3B82F6" }
/* Reference another token */
{ "$value": "{color.primitive.blue.500}" }
/* With metadata */
{
"$value": "{color.primitive.blue.500}",
"$type": "color",
"$description": "Primary action color"
}
Common Token Patterns:
Color tokens:
color.background.primary
color.text.primary
color.border.default
color.action.primary
Spacing tokens:
spacing.xs (4px)
spacing.sm (8px)
spacing.md (16px)
spacing.lg (24px)
Typography tokens:
typography.body.md
typography.heading.lg
Quick Troubleshooting:
Token not working?
1. Check spelling (case-sensitive)
2. Verify token exists in catalog
3. Check CSS custom property syntax (var(--name))
4. Inspect element to see computed value
Reference error?
1. Check path matches exactly
2. Verify referenced token exists
3. Check for circular references
4. Run token validation
Key Considerations
- Cheat sheets should be scannable, not readable
- Group information by task or category
- Include actual syntax, not just descriptions
- Update when tokens change
- Make easily accessible (bookmark, print)
- Cover the 80% most common cases
- Link to detailed docs for complex topics
- Version alongside token releases
Common Questions
What format works best for cheat sheets?
Format should optimize for quick scanning and frequent access.
Single-page PDF:
+------------------+------------------+
| CSS Syntax | Token Types |
| var(--name) | color.* |
| var(--name, fb) | spacing.* |
+------------------+------------------+
| Common Tokens | Troubleshooting |
| color.primary | Check spelling |
| spacing.md | Verify exists |
+------------------+------------------+
Advantages: Printable, offline access, quick scanning Disadvantages: Requires updates, limited space
Web page:
<section id="syntax">
<h2>CSS Syntax</h2>
<pre><code>var(--token-name)</code></pre>
</section>
Advantages: Searchable, updatable, linkable Disadvantages: Requires connectivity
IDE snippet:
{
"Token": {
"prefix": "tok",
"body": ["var(--$1)"],
"description": "Insert token reference"
}
}
Advantages: In-context, reduces typing Disadvantages: IDE-specific
What categories should a cheat sheet include?
Categories should match common lookup needs.
Essential categories:
## Quick Reference
### Syntax
- CSS custom property: `var(--token-name)`
- Fallback: `var(--token-name, fallback)`
- JSON reference: `{token.path}`
### Finding Tokens
- Catalog: docs.company.com/tokens
- Search: Cmd+K in documentation
- IDE: Enable token autocomplete
### Common Tokens
[Table of most-used tokens]
### Theming
- Light: default (no attribute)
- Dark: `data-theme="dark"`
- Toggle: `document.documentElement.dataset.theme = 'dark'`
### Troubleshooting
[Common issues and solutions]
### Getting Help
- Slack: #design-system-help
- Docs: docs.company.com
How should cheat sheets be distributed?
Distribution should make cheat sheets easy to find and use.
Documentation site section:
docs/
getting-started/
tokens/
cheat-sheet/ ← Prominent placement
index.md
printable.pdf
Team resources:
- Pinned in #design-system Slack channel
- Linked from onboarding materials
- Included in project templates
Development environment:
- IDE plugin with token lookup
- Browser bookmark to cheat sheet
- CLI tool for token search
Physical distribution:
- Printed desk references
- Laminated cards for quick lookup
Summary
Design token cheat sheets provide quick reference for common tasks, syntax, and troubleshooting. Effective cheat sheets are scannable, grouped by task, and include actual code syntax. Formats include printable PDFs, web pages, and IDE snippets. Essential categories cover syntax, finding tokens, common tokens, theming, troubleshooting, and getting help. Distribution through documentation, team channels, and development environments ensures easy access.
Buoy scans your codebase for design system inconsistencies before they ship
Detect Design Drift Free