AXA CH Design Tokens
The AXA CH Design Tokens project exports design tokens for use in multiple technologies. The following technologies are supported:
- CSS Variables + Media Queries with @custom-media
- SCSS Variables
- JS/TS Variables
- Tailwind Config
If you need our design tokens for a web project you might check this Online demo
Supported Tokens
The project supports the following design tokens:
- Animation: Variables needed to handle component animations.
- Breakpoints/Media Queries: AXA viewport breakpoints and additional media query utilities.
- Color: AXA colors.
- Radius: Box radius variables.
- Shadow: Box shadow variables.
- Spacing: AXA Design System spacing variables.
- Typography: AXA Design System font styles.
Installation
To install the AXA CH Design Tokens, run the following command:
npm i @axa-ch/design-tokens
Usage
To use the AXA CH Design Tokens in your project, import them based on your technology. Here are some implementation examples that may inspire you:
CSS Usage
You can import the CSS variables into your files as follows:
@import url('@axa-ch/design-tokens/tokens.css');
.component {
width: var(--spacing-base-3);
}
Note that for CSS media queries via @custom-media you will need a postCSS plugin
@import url('@axa-ch/design-tokens/tokens.css');
.component {
width: var(--spacing-base-3);
@media (--mq-respond-up-sm) {
width: var(--spacing-base-6);
}
}
Plain CSS
If you want to simply import the pre-bundled css variables without relying on a build process, you can import the minified tokens.min.css
file as follows:
<link
rel="stylesheet"
href="https://github.com/axa-ch/design-tokens/blob/main/@axa-ch/design-tokens/tokens.min.css"
/>
Note that the css above doesn't contain @custom-media
variables because this directive is not yet supported by any modern browser.
SCSS Usage
You can import the SCSS variables into your files as follows:
@use '@axa-ch/design-tokens/tokens.scss';
.component {
width: tokens.$spacing-base-3;
@media (tokens.$mq-respond-up-sm) {
width: tokens.$spacing-base-6;
}
}
In case you want to import and scope the css variables into your SCSS application, without relying on the :root
global selector, you might want to use our mixins as follows:
@use '@axa-ch/design-tokens/tokens.scss';
.component {
// scope the css variables under the .component class
@include tokens.get-animation-css-vars;
@include tokens.get-breakpoints-css-vars;
@include tokens.get-color-css-vars;
@include tokens.get-radius-css-vars;
@include tokens.get-shadow-css-vars;
@include tokens.get-spacing-css-vars;
@include tokens.get-typography-css-vars;
}
JS/TS Usage
You can import the JS variables into your files as follows:
import * as tokens from '@axa-ch/design-tokens';
console.log(tokens.ColorBaseAxaBlue);
MUI Theme Config Starter
The following theme config might be used as starter for your MUI theme
```ts
import {
BreakpointsBaseLg,
BreakpointsBaseMd,
BreakpointsBaseSm,
BreakpointsBaseXl,
BreakpointsBaseXs,
BreakpointsBaseXxl,
ColorBaseAxaBlue,
ColorBaseAxaBlueDark,
ColorBaseAxaBlueLight,
ColorStatusMalachite,
ColorStatusShyTomato,
ColorGreyscale9,
ColorGreyscale3,
ColorUiDesignBurntSienna,
ColorUiDesignBurntSiennaDark,
ColorUiDesignBurntSiennaLight,
ColorUiDesignDarkGrey,
ColorUiDesignAlabaster,
SpacingBase1,
SpacingBase10,
SpacingBase2,
SpacingBase3,
SpacingBase4,
SpacingBase5,
SpacingBase6,
SpacingBase7,
SpacingBase8,
SpacingBase9,
TypographyPrimaryH1,
TypographyPrimaryH1Small,
TypographyPrimaryH2,
TypographyPrimaryH2Small,
TypographyPrimaryH3,
TypographyPrimaryH3Small,
TypographyPrimaryH4,
TypographyPrimaryH4Small,
TypographyPrimaryH5,
TypographyPrimaryH5Small,
TypographyPrimaryH6,
TypographyPrimaryH6Small,
TypographyText3,
ShadowBoxDefault,
} from '@axa-ch/design-tokens';
import { createTheme } from '@mui/material';
const { breakpoints } = createTheme({
breakpoints: {
values: {
xs: BreakpointsBaseXs,
sm: BreakpointsBaseSm,
md: BreakpointsBaseMd,
lg: BreakpointsBaseLg,
xl: BreakpointsBaseXl,
xxl: BreakpointsBaseXxl,
},
},
});
// borrowed from styledictionary
// @link https://github.com/amzn/style-dictionary/blob/399de1331adfa16a94ba3f724a54f9267aa23345/lib/common/transforms.js#L1343C6-L1352C9
const stringifyShadow = (val: {
type: string;
color: string;
offsetX: string;
offsetX: string;
blur: string;
spread: string;
}) => {
const { type, color, offsetX, offsetY, blur, spread } = val;
return `${type ? `${type} ` : ''}${offsetX ?? 0} ${offsetY ?? 0} ${blur ?? 0} ${
spread ? `${spread} ` : ''
}${color ?? `#000000`}`;
};
const theme = createTheme({
palette: {
primary: {
main: ColorBaseAxaBlue,
dark: ColorBaseAxaBlueDark,
light: ColorBaseAxaBlueLight,
},
secondary: {
main: ColorUiDesignBurntSienna,
dark: ColorUiDesignBurntSiennaDark,
light: ColorUiDesignBurntSiennaLight,
},
error: {
main: ColorStatusShyTomato,
},
success: {
main: ColorStatusMalachite,
},
background: {
default: ColorUiDesignAlabaster,
paper: ColorGreyscale9,
},
text: {
primary: ColorUiDesignDarkGrey,
secondary: ColorGreyscale3,
},
},
spacing: [
0,
SpacingBase1,
SpacingBase2,
SpacingBase3,
SpacingBase4,
SpacingBase5,
SpacingBase6,
SpacingBase7,
SpacingBase8,
SpacingBase9,
SpacingBase10,
],
breakpoints: {
values: {
xs: BreakpointsBaseXs,
sm: BreakpointsBaseSm,
md: BreakpointsBaseMd,
lg: BreakpointsBaseLg,
xl: BreakpointsBaseXl,
xxl: BreakpointsBaseXxl,
},
},
typography: {
fontFamily: TypographyText3.fontFamily,
fontSize: TypographyText3.fontSize,
allVariants: {
fontFamily: TypographyText3.fontFamily,
fontSize: TypographyText3.fontSize,
lineHeight: TypographyText3.lineHeight,
color: ColorUiDesignDarkGrey,
},
body1: {
fontFamily: TypographyText3.fontFamily,
fontSize: TypographyText3.fontSize,
lineHeight: TypographyText3.lineHeight,
},
h1: {
...TypographyPrimaryH1Small,
[breakpoints.up('md')]: TypographyPrimaryH1,
},
h2: {
...TypographyPrimaryH2Small,
[breakpoints.up('md')]: TypographyPrimaryH2,
},
h3: {
...TypographyPrimaryH3Small,
[breakpoints.up('md')]: TypographyPrimaryH3,
},
h4: {
...TypographyPrimaryH4Small,
[breakpoints.up('md')]: TypographyPrimaryH4,
},
h5: {
...TypographyPrimaryH5Small,
[breakpoints.up('md')]: TypographyPrimaryH5,
},
h6: {
...TypographyPrimaryH6Small,
[breakpoints.up('md')]: TypographyPrimaryH6,
},
},
shadows: ['none', stringifyShadow(ShadowBoxDefault)],
shape: {
borderRadius: 0,
},
});
export default theme;
```
Tailwind Usage
You can extend your tailwind.config.js
file as follows:
import axaBaseTailwindConfig from '@axa-ch/design-tokens/tailwind.config';
export default {
presets: [axaBaseTailwindConfig],
// ...
};
Figma usage
You can import the tokens.json
into figma via Tokens Studio Plugin.
This will allow to sync your figma library with the tokens exposed in this project.