@paprika/tokens

@paprika/tokens

Description

The tokens package is the implementation of the Starling Design System's design tokens for use with Sass and JavaScript (for use with styled-components).

They include an extensive colour palette, spacing values, and other CSS properties to keep the styling conssitent for apps created with Paprika.

On the Paprika wiki pages, you can read more about using design tokens.

The Starling Design System site has a tokens reference page.

Installation

yarn add @paprika/tokens

or with npm:

npm install @paprika/tokens

Usage

tokens are intended for use internally and externally.

Internally, when contributors create Paprika components, and externally, when application developers consume Paprika to create user interfaces with the Starling Design System.

Consumers

Typically consumers will be using tokens with Sass. They can be included in any Sass file with:

@import "@paprika/tokens/lib/tokens.scss";

Then you should be able to use variables like $space and $color--black-lighten-10.

Contributors

When using tokens in Paprika, or even in an application that uses styled-components or another CSS-in-JS framework, the tokens can be imported with:

import tokens from "@paprika/tokens";

Then you can access the tokens from that tokens object, like tokens.space or tokens.color.blackLighten10.

With styled-components you will usually use them in a template string, interpolated like ${tokens.space}.

Adding New Tokens

The source file for the tokens is src/tokens.yaml. New tokens can be added there and then generated for Sass, JavaScript and even for the Starling Design System reference page by running the folloing in the packages/Tokens directory:

yarn pretranspile

Which will generate the following:

• tokens.js
• tokens.json
• tokens.scss
• tokens.md

Links

• Starling Design System tokens reference
• Paprika coding conventions wiki
• Github source code
• Github create issue
• ChangeLog