Vanilla component design specs

What to include when writing a design spec for a Vanilla pattern

This document describes what to include when writing a Vanilla component design spec.

Location

Design specs live in the code section of the Vanilla design repo, or of the corresponding theme’s design repo (e.g. Brochure theme design repo).

Structure

Each component should have its own folder, and include two files:

  • Detailed written spec (.md format)
  • Visual spec (.png format)

Detailed written spec

The detailed spec file should include:

  • Title of the component: e.g. “Vanilla: Buttons” or “Brochure theme: Buttons
  • All the properties needed to build the pattern: e.g. font size, text colour, padding, borders, shadows, backgrounds
  • Where applicable, include responsive variations for different viewports
  • Where applicable, include: hover, active and focused states

The spec shouldn’t be written in CSS format. For example, avoid writing “font-size”, write “font size” instead.

Some properties should be defined using Vanilla variables, to maintain consistency across the framework. These are:

Written specs should follow the Canonical copy style guide.

Visual spec

The visual specs for Vanilla live in a single Sketch file. The latest version of this file can be found in the root of the design repo.

Each artboard of the file represents one component. This makes it easier to export a flat image of the component, which will be its visual spec.

The visual spec does not have to include any written properties (measurements, etc.), however in some cases adding key values might be useful for quick reference. For example, the size of the icons in the heading icon pattern.