@genie-solutions/motif-tokens

Motif Tokens

Design Tokens for the Motif Design System.

This package is mostly useful when you need to create styling or tooling that is aligned to Motif, but cannot leverage the core Motif React library.

If you're developing a React app, use the core Motif React library.

If you're creating something like a custom bootstrap theme, a Figma plugin, use these tokens.

Read a bit more about Design Tokens concept here: https://spectrum.adobe.com/page/design-tokens/ https://css-tricks.com/what-are-design-tokens/

Using the tokens in your project

1. Install library

The library is deployed to npm and installed via an npm package. See it here.

yarn add @genie-solutions/motif-tokens

2. Transform tokens into the data you need

SCSS:

Use case: I have a project that uses SCSS and I need access to Motif's tokens.

Solution: Utilise the exported tokens.scss file to access all of the vars.

// my-style.scss
@import '../node_modules/motif-tokens/tokens.scss';

article {
    background-color: $motif-color-primary;
}

JavaScript:

Use case: I need to create style definitions in JavaScript that utilise values from the Motif Tokens.

Solution: import the Motif Tokens JavaScript file and "transform" the tokens into the format you need.

Example:

// FontWeights Tokens in package
const FontWeights: { [x: string]: FontWeightToken } = {
    regular: {
        name: 'regular',
        description: 'Regular font weight used with the default text.',
        data: { weightAsString: 'Regular', weight: 400 },
    },
    // ...
};

import { FontWeights } from 'motif-tokens';

// Take each font weight and transform them to an object
const fontWeights = () => {
  const output = {};
  FontWeights.map(({ name, value, unit }) => (output[name] = `${value}${unit}`));
  return output;
};

// Sample Output:
const fontWeights: {
    regular: 400,
    // ...
}

Developing / Contributing to the tokens

Install

1. Install dependencies

yarn install

1. Build the tokens

yarn build

Publishing Changes

Any marge to master that will result in a new build + deploy of @genie-solutions/motif-tokens on NPM. You don't need to bump the version number manually, the pipeline will do that based on the MAJOR, MINOR and PATCH labels added to the MR.

Not all files will trigger the deploy, it's namely the following as listed in .gitlab-ci.yml:

src/**/*
yarn.lock
package.json
webpack.config.js