Suomifi Design System Tokens

The Design System Tokens repository contains color, typography and spacing definitions as tokens following the Suomi.fi-brand. The repository uses semantic versioning (https://semver.org/).

✨ Features

The design system tokens are available in SCSS and JavaScript formats. Typings for TypeScript are also available.

The following token types are currently available:

• colors
• typography
• spacing

📦 Install

yarn add suomifi-design-tokens

🔨 Usage

SCSS

Tokens are available as named SCSS variables and mixins with $fi- prefix. Tokens can be imported to scss files:

@import '~suomifi-design-tokens/dist/tokens';

🎨 Colors

Color tokens are available as variables with additional color- prefix. Colors are provided as hsl values.

Excerpt from tokens.scss:

$fi-color-brand-base: hsl(214, 100%, 24%);

Example use case:

.custom-class {
  background-color: $fi-color-brand-base;
}

🖋 Typography

Typography tokens are available as mixins with additional text- prefix.

Excerpt from tokens.scss:

@mixin fi-text-heading1 {
  font-family: 'Source Sans Pro', 'Helvetica Neue', 'Arial',
    sans-serif;
  font-size: 40px;
  line-height: 48px;
  font-weight: 300;
}

Example use case:

h1 {
  @include fi-text-heading1;
}

📏 Spacing

Spacing tokens are available as variables with additional spacing- prefix.

Excerpt from tokens.scss:

$fi-spacing-l: 32px;

Example use case:

.custom-class {
  margin: $fi-spacing-l;
}

JavaScript and TypeScript

Tokens are available as named suomifiDesignTokens export and can be imported to JavaScript and TypeScript files.

suomifiDesignTokens exports the design tokens as css formatted strings and in more granular format so that individual properties are available with values and units.

JavaScript example:

import { suomifiDesignTokens } from 'suomifi-design-tokens';

TypeScript example with typings:

import {
  suomifiDesignTokens,
  DesignTokens
} from 'suomifi-design-tokens';

const tokens: DesignTokens = suomifiDesignTokens;

🎨 Colors

Color tokens are available with colors property as css strings. Separated h, s and l values can be accessed through values property.

Excerpt from suomifiDesignTokens object:

exports.suomifiDesignTokens = {
  colors: {
    whiteBase: 'hsl(0, 0%, 100%)'
  },
  values: {
    colors: {
      whiteBase: { h: 0, s: 0, l: 100 }
    }
  }
};

JavaScript example:

const brandBaseLightness =
  suomifiDesignTokens.values.colors.brandBase.l;

const brandBaseCss = suomifiDesignTokens.colors.brandBase;

TypeScript example with typings:

import { ColorToken } from 'suomifi-design-tokens';

const brandBase: ColorToken =
  suomifiDesignTokens.values.colors.brandBase;
const brandBaseLightness: string = brandBase.l;

const brandBaseCSS: string = suomifiDesignTokens.colors.brandBase;

🖋 Typography

Typography tokens are available with typography property as css strings. Separated fontFamily, fontSize, lineHeight and fontWeight properties can be accessed through values property.

Excerpt from suomifiDesignTokens object:

exports.suomifiDesignTokens = {
  typography: {
    heading1:
      "font-family: 'Source Sans Pro', 'Helvetica Neue', 'Arial', sans-serif; font-size: 40px; line-height: 48px; font-weight: 300;"
  },
  values: {
    typography: {
      heading1: {
        fontFamily:
          "'Source Sans Pro', 'Helvetica Neue', 'Arial', sans-serif",
        fontSize: { value: 40, unit: 'px' },
        lineHeight: { value: 48, unit: 'px' },
        fontWeight: 300
      }
    }
  }
};

JavaScript example:

const heading1 = suomifiDesignTokens.values.typography.heading1;
const heading1FontSize =
  heading1.fontSize.value + heading1.fontSize.unit;
const heading1FontFamily = heading1.fontFamily;

const heading1Css = suomifiDesignTokens.typography.heading1;

TypeScript example with typings:

import { TypographyToken } from 'suomifi-design-tokens';

const heading1: TypographyToken =
  suomifiDesignTokens.values.typography.heading1;
const heading1FontSize: string =
  heading1.fontSize.value + heading1.fontSize.unit;
const heading1FontFamily: string = heading1.fontFamily;

const heading1Css: string = suomifiDesignTokens.typography.heading1;

📏 Spacing

Spacing tokens are available with spacing property as CSS strings. Separated unit and value properties can be accessed through values property.

Excerpt from suomifiDesignTokens object:

exports.suomifiDesignTokens = {
  spacing: {
    l: '32px'
  },
  values: {
    spacing: {
      l: { value: 32, unit: 'px' }
    }
  }
};

JavaScript example:

const spacingL = suomifiDesignTokens.values.spacing.l;
const spacingLWithUnit = spacingL.value + spacingL.unit;

const spacingLCss = suomifiDesignTokens.spacing.l;

TypeScript example with typings:

import { ValueUnit } from 'suomifi-design-tokens';

const spacingL: ValueUnit = suomifiDesignTokens.values.spacing.l;
const spacingLWithUnit: string = spacingL.value + spacingL.unit;

const spacingLCss: string = suomifiDesignTokens.spacing.l;

⌨️ Development

See DEVELOPMENT.md.

Licensing

MIT LICENSE