@vtmn/css-design-tokens

@vtmn/css-design-tokens

Decathlon Design System - Vitamin specific CSS styles for design tokens

Install package

After installing npm or yarn, you can install @vtmn/css-design-tokens with this command:

# with npm
npm i -S @vtmn/css-design-tokens

# with yarn
yarn add @vtmn/css-design-tokens

Or you can also install it with a CDN like unpkg.com:

<link rel="stylesheet" href="https://unpkg.com/@vtmn/css-design-tokens" />

Install fonts

Roboto & Roboto Condensed fonts as described in Typography section will not be automatically loaded. Fortunately, there is a few easy ways to get started.

You can install them with FontSource:

# with npm
npm i -S @fontsource/roboto @fontsource/roboto-condensed

# with yarn
yarn add @fontsource/roboto @fontsource/roboto-condensed

Then, within your app entry file or site component, import it in:

import '@fontsource/roboto'; // Defaults to weight 400
import '@fontsource/roboto/400.css'; // Specify weight
import '@fontsource/roboto/400-italic.css'; // Specify weight and style

In order to enhance performance of your app, please read about font subsetting. FontSource explains it here.

Otherwise, you can also load them through CDN:

<link
  rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;700&family=Roboto+Condensed:ital,wght@0,400;0,700;1,700&display=swap"
/>

Finally, you can also import them via CSS import:

@import url('https://fonts.googleapis.com/css2?family=Roboto:wght@400;700&family=Roboto+Condensed:ital,wght@0,400;0,700;1,700&display=swap');

Usage

Once you have installed this package, you just have to import CSS styles!

With a bundler that supports CSS imports in JS files:

import '@vtmn/css-design-tokens/dist/index.css';

Otherwise include it in your HTML file:

<link
  rel="stylesheet"
  href="./node_modules/@vtmn/css-design-tokens/dist/index.css"
/>

Development

To know all the use cases and their associated code, check out the showcase guidelines here.

For example:

<p style="color: var(--vtmn-semantic-color_content-primary)">Hello World!</p>

You can see the different CSS Custom Properties here.

Scss & Less outputs

In addition to CSS Custom Properties output this package also provides design tokens as scss or less variables. See .scss and .less files within the dist folder.

Base 10 support

If your project uses the mathematical trick of basing the value of 1rem equals 10px, there is also an index-base10 output within the dist folder of this package.

Changelog

If you want to know the different changes between versions of this package, look at the changelog here.

I have an issue, what should I do?

Please file the issue here.

Contributing

See the contributing docs.

License

Apache-2.0 © Decathlon