Design tokens

We use tokens instead of static values (like HEX codes) for color or sizing units.

If you’re already using @kiwicom/orbit-components, you don’t need to install the tokens because they’re included as a dependency to ensure compatibility.

You can install the package on its own.

// Using npm
npm install --save @kiwicom/orbit-design-tokens
// Using yarn
yarn add @kiwicom/orbit-design-tokens

To use the default tokens, add an import in the file where you want to use the design tokens.

import defaultTheme from "@kiwicom/orbit-components/lib/defaultTheme";

Now you can use tokens by entering defaultTheme.orbit and continuing the dot-notation with the token name you want to use, such as defaultTheme.orbit.colorTextPrimary. More advanced text editors should suggest which tokens are available to you so you can find tokens quicker than by typing the entire token name.

You can also create your own tokens for themes using getTokens from @kiwicom/orbit-components and create custom uses in styled-components. See more at Theming.

To use the default tokens, add an import in the file where you want to use the design tokens.

import { defaultTokens } from "@kiwicom/orbit-design-tokens";

Now you can use tokens by typing defaultTokens and continuing the dot-notation with the token name you want to use, such as defaultTokens.colorTextPrimary. More advanced text editors should suggest which tokens are available to you so you can find tokens quicker than by typing the entire token name.

You can also create your own tokens for themes using getTokens from @kiwicom/orbit-design-tokens and create custom uses in styled-components. See more at Theming.

You can download the tokens as XML.

The main structure of the package is written in JavaScript for better usage in JavaScript projects. We’re also able to generate a JSON file, which enables us to transform this type of file into different ones. It should be possible to transform JSON into SASS, LESS, Stylus, XML, and others.

Every design token in the package has a name according to the Orbit naming conventions. These conventions should be systematic and work according to the following template:

property_usage-type--state