Design system component

Document one component - when to use it, its variants and its rules.

DesignEngineering


Component

The name of the component, as it is in the design file and in the code

Owner

@mention the owner

Status

🟡 Beta | 🟢 Stable | ⚪ Deprecated

Overview

One or two sentences: what the component is, and what it helps users do.

Design file and code: links, or delete this line

When to use it

✅ Use when

  • A situation where this component is the right choice

🚫 Do not use when

  • A situation where another component is better, and which one

Variants

Variant

Use for

The name of the variant, for example primary or small

When to use this variant

Behavior and states

  • A state, for example hover, focus, disabled, loading or error, and how the component looks and acts in it
  • What happens when the text is too long or the screen is small

Accessibility

  • You can reach and use the component with the keyboard alone.
  • The focus is always visible.
  • A screen reader announces its name, its role and its state.
  • The text and the icons have enough color contrast.
  • It does not use color as the only way to show a meaning.
  • A check for this component only, or delete this line

Content guidelines

How to write the text in the component: the tone, the length, and the words to use or to avoid.

An example of good text, and an example of text to avoid.

allanswered knowledge management