@aurodesignsystem/design-tokens

Auro Design Tokens

Install

$ npm i @aurodesignsystem/design-tokens

Use pre-processed resources

Located in the ./dist/tokens directory of the npm.

└── tokens
   ├── CSSCustomProperties.css
   ├── CSSSizeCustomProperties.css
   ├── JSData--color.js
   ├── JSObject--allTokens.js
   ├── JSObject--deprecated.js
   ├── JSVariables--color.js
   ├── SCSSVariableMap.scss
   ├── SCSSVariables.scss
   ├── SCSSVariablesMapFlat.scss
   ├── SassCustomProperties.scss
   ├── SassSizeCustomProperties.scss
   └── darkmode
      ├── CSSCustomProperties.css
      ├── JSDataColor.js
      ├── JSObject--allDarkTokens.js
      ├── JSVariablesColor.js
      ├── SCSSVariables.scss
      ├── SCSSVariablesMapFlat.scss
      └── SassCustomProperties.scss

Resource Descriptions

file	syntax	type	status	filter type / description
CSSCustomProperties	CSS	custom properties	current	full list of v3.0x release tokens
CSSSizeCustomProperties	CSS	custom properties	current	filter: size, public
JSData--color	JS module	color data	current	filter: color, current
JSObject--deprecated	JS module	deprecated tokens	current	filter: deprecated, pubic
JSObject--allTokens.js	JS module	all data	current	filter: public
JSVariables--color	js es6	color data	current	filter: color
SCSSVariableMap	Sass	Sass variable map	current	filter: size, public
SCSSVariables	scss	Sass variables	current	full list of v3.0x release tokens
SCSSVariablesMapFlat	scss	Scss variable map	current	full list of v3.0x release tokens
SassCustomProperties	scss	custom properties	current	full list of v3.0x release tokens
SassSizeCustomProperties	Sass	custom properties	current	filter: size, public

Migration from 3.x to 4.x

With the release of Auro Design Tokens 4.x a new variable namespace was introduced. The project has removed --auro and replaced with --ds. This was done to support upcoming theming capabilities.

Since not all Auro web components are using the new tokens, simply removing the 3.x version and replacing with the 4.x version will break your UI.

To allow for a seamless transition between the two sets of design tokens, we highly recommend the following install supoprt.

1. In your app, please install the new @aurodesignsystem/design-tokens@4.x, but DO NOT uninstall @alaskaairux/design-tokens@3.15.5.
2. Update to use the new @aurodesignsystem/webcorestylesheets which fully supports the new token naming spec.
3. Please review the Deprecated tokens list for a matrix of changes. Understand that some tokens have been removed from the project and need to be updated.

By allowing your project to support both the legacy and new Auro design tokens, this will ensure a smooth transition until all Auro components have been updated and your project has also updated local SCSS/CSS files with the new references.

Install with Sass

@import "~@aurodesignsystem/design-tokens/dist/tokens/SCSSVariables";

// or

@import "~@aurodesignsystem/design-tokens/dist/tokens/SassCustomProperties";

Install with CSS

With React or similar framework, the CSS file can be imported directly from the npm:

import "@aurodesignsystem/design-tokens/dist/tokens/CSSCustomProperties.css"

For other frameworks, it's suggested that the CSS file be copied from the npm into the scope of the project with a build scenario.

Install ESModules

Within a webpack supported application or a type="module" script:

import { AuroColorAlertNotificationOnLight, AuroColorBorderErrorOnLight } from '@aurodesignsystem/design-tokens/dist/tokens/JSVariables--color.js';

Install from CDN

Using the https://cdn.jsdelivr.net/npm/ CDN, every file in the dist directory can be accessed like so.

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm//@aurodesignsystem/design-tokens@latest/dist/tokens/CSSCustomProperties.css">

NOTE: Please use caution when using the CDN solution. We are not responsible for the CDN https://cdn.jsdelivr.net/ uptime and are unable to effectively troubleshoot when there are response issues. It is recommended to use the installed version of Auro Design Tokens when using them in critical UIs.

Changelog

4.2.0 (2023-11-07)

Features

• base: add new white tokens with different opacities (b5a11d6)
• gradient: add new gradient token for white backgrounds #135 (f6e99a4)