ubie-oss / design-tokens

Apache License 2.0
33 stars 1 forks source link

Ubie Design Tokens

This is a package for using the design tokens defined in Ubie's products in development. Design tokens are managed in JSON format and are converted to the format for each platform using Style Dictionary.

Figma file is published in Figma Community. https://www.figma.com/community/file/1139108856002045571

Usage

npm install @ubie/design-tokens

This package contains files with three extensions: CSS, SCSS, and JS.

CSS

@import url('node_modules/@ubie/design-tokens/dist/tokens.css');

SCSS

@import 'node_modules/@ubie/design-tokens/dist/tokens.scss';

JS

import DesignTokens from '@ubie/design-tokens';

Development

  1. create .env file and include file id and token
cp .env_sample .env
  1. Convert design tokens defined in Figma to JSON format files
npm run build:figma
  1. Converts JSON files to the format used by each platform
npm run build:tokens

Edit config.json if you need to add a supported platform. Please refer to the Style Dictionary documentation for details.

LICENSE

This Ubie Design Tokens is licensed under the Apache License 2.0.