@sbb-esta/lyne-design-tokens
v1.3.0
Published
Managing and publishing design tokens for the lyne design system: https://github.com/sbb-design-systems/lyne-components
Downloads
692
Readme
Lyne Design Tokens
Automatically generate cross-platform Design Tokens for the Lyne Design System based json properties files
and publish them as @sbb-esta/lyne-design-tokens
npm package.
Installation
Install the Lyne Design Tokens with the following command:
npm install --save-dev @sbb-esta/lyne-design-tokens
What's included
lyne-design-tokens/
├── composed-variables/ # Composed CSS variables like responsive tokens
├── designTokens/ # Token source files
└── dist/ # These files get built through the build task and get published via npm — are part of the npm package
├── css/
│ ├── sbb-variables--host.css # `sbb-` prefixed CSS variables with :host selector (converted to `rem`)
│ └── sbb-variables--root.css # `sbb-` prefixed CSS variables with :root selector (converted to `rem`)
├── js/
│ ├── sbb-tokens-raw.json # `sbb-` prefixed nested .json file
│ ├── sbb-tokens.mjs # `Sbb` prefixed flat esm file
│ ├── sbb-tokens.cjs # `Sbb` prefixed flat commonjs file
│ ├── sbb-tokens.d.ts # `Sbb` prefixed flat type declaration
│ └── sbb-tokens.json # `sbb-` prefixed flat .json file
└── scss/
├── sbb-variables_css--placeholder.scss # `sbb-` prefixed CSS variables with Sass placeholder selector (%) (converted to `rem`)
└── sbb-variables.scss # `sbb-` prefixed Sass variables (converted to `rem`)
Usage
Have a look at the dist folder inside node_modules: ./node_modules/@sbb-esta/lyne-design-tokens/dist/
.
There you will find the different variables files which you can import and use in your project.
Development
Conventional Commits
Please follow the Conventional Commits specification to make sure we can automatically determine the next release version if necessary.
Components
See Lyne Components for components using these design tokens.