Token Naming Conventions

Token Naming Conventions Overview

Token Naming Conventions lets you structure design systems work so it stays readable, testable, and easy to scale. Instead of ad-hoc code, you follow a clear pattern that other developers can recognise immediately.

The key is to keep token naming conventions focused and predictable. Start from the minimal example here, then layer in only the complexity your feature actually needs.

// tokens.json (design tokens)
{
  "color": {
    "brand": { "500": { "value": "#2563eb" } },
    "text":  { "default": { "value": "{color.brand.500}" } }
  },
  "space": {
    "sm": { "value": "8px" },
    "md": { "value": "16px" }
  }
}

Design tokens store design decisions as data so they can be shared across platforms and themes.

Token Naming Conventions Example

/* Tokens flow into components, which flow into products */
:root { --color-brand-500: #2563eb; }
.button { background: var(--color-brand-500); }

• Start from a minimal Token Naming Conventions example and grow it only as needed.
• Keep configuration explicit so Token Naming Conventions behaves the same in every environment.
• Name things clearly so teammates understand your Token Naming Conventions at a glance.
• Add tests around Token Naming Conventions early to lock in expected behaviour.

Design System Cheatsheet

Quick reference for token naming conventions within a modern design system.

How Token Naming Conventions Fits into a Design System

Token Naming Conventions connects the design decisions in your system to the code teams actually ship. When it is defined once and reused, products stay consistent and updates roll out everywhere.

Design tokens store design decisions as data so they can be shared across platforms and themes.

• Define it once as a token or shared component.
• Document intended usage with clear examples.
• Make it themeable and accessible by default.
• Version and release changes so consumers can upgrade safely.

Getting Teams to Adopt Token Naming Conventions

Adoption is where design systems succeed or stall. Make token naming conventions the easiest option: great docs, sensible defaults, and clear migration paths beat mandates every time.

Common Mistakes

• Skipping error handling and edge cases when wiring up token naming conventions.
• Leaving token naming conventions untested, so regressions slip into production.
• Over-engineering token naming conventions before you actually need the extra flexibility.
• Ignoring documentation, which makes token naming conventions hard for the next developer to change.

Key Takeaways

• Token Naming Conventions is a core part of working effectively with design systems.
• Start small and keep token naming conventions focused on a single responsibility.
• Apply consistent patterns so token naming conventions scales across your project.
• Test and document token naming conventions to keep it maintainable over time.