/vue-tokens-presenters

Design tokens is an integral part of any design system and a very important part of the product. It helps you to keep your design consistent and solid.

Primary LanguageTypeScriptMIT LicenseMIT

Welcome to vue-tokens-presenters 👋

Version Documentation Maintenance License: MIT Twitter: 11joselu

List of presenter for design tokens

Install

npm i -S vue-tokens-presenters

Usage

Works well with design-tokens-parser

Working with design-tokens-parser

import { scssParser } from 'design-tokens-parser';
import TokenSumarry from 'vue-tokens-presenters';

const scssReq = require.context(
  `!!raw-loader!../<MY_PATH>`,
  true,
  /tokensFiles.scss$/
);

// We create and array of file path
const files = scssReq.keys();
const tokens = files
      .map((filename) => scssReq(filename).default) // read file content
      .map(scssParser) // parse file content and return a doube array of tokens
      .flat() // flat double array into single array


<TokenSumarry tokens={tokens}/>

In cases where you need a custom layout, you have presenter to reuse them.

import { scssParser } from 'design-tokens-parser';
// We import Color
import {Color} from 'vue-tokens-presenters';

const scssReq = ...

// We create and array of file path
const files = scssReq.keys();
const tokens = ...

tokens.map((token, index) => <Color {...token} key={index} />)

Presenters

Presenters are used to render examples for your design tokens. View availables presenters

Run tests

npm run test

Author

👤 Jose Cabrera

Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Jose Cabrera.
This project is MIT licensed.