category: packages
ui-token-scripts
Utility scripts for generating cross-platform tokens from InstUI themes.
Installation
yarn add @instructure/ui-token-scriptsSupported Platforms & Languages
ui-token-scripts currently only targets SCSS. In the future, we will explore adding support for additional platforms and languages.
Available Commands
generate-tokens <options>
Generate cross-platform design tokens for the given theme.
generate-all-tokens
Generate cross-platform design tokens for all themes in configuration.
Note: Project root must contain a configuration file containing a collection of configuration objects. This configuration may be leveraged to support theme-specific platform targeting in the future.
// ui-token-scripts.config.js
module.exports = [
{
themeKey: 'canvas',
tokensPackage: '@instructure/ui-theme-tokens',
tokensPath: 'lib/canvas',
},
{
themeKey: 'canvas-ams',
tokensPackage: '@instructure/ui-theme-tokens',
tokensPath: 'lib/canvas-ams',
},
]
Documentation
For more documentation on available options and parameters for individual commands run:
ui-token-scripts <command> --help