@odx/design-tokens
v3.4.0
Published
ODX Design Tokens
Readme
@odx/design-tokens
The @odx/design-tokens package provides a centralized collection of design tokens for the ODX Design System. These tokens include essential design variables such as colors, spacing, typography scales, and other key visual attributes, ensuring consistency and cohesion across all ODX projects.
Features
- Design Tokens: Centralized collection of design variables for colors, spacing, typography, and more.
- CSS Variables: Exported as CSS custom properties for easy integration into your stylesheets.
- JavaScript and TypeScript Support: Available as JavaScript and TypeScript modules for seamless integration into your codebase.
Install
To include @odx/design-tokens in your project, run the following command:
npm install @odx/design-tokens --saveSetup
Once installed, you can import the design tokens and fonts into your project:
CSS
@import "@odx/design-tokens/fonts";
@import "@odx/design-tokens/css";
// or
@import "@odx/design-tokens/assets/fonts.css";
@import "@odx/design-tokens/dist/tokens.css";JavaScript
// import CSS variables
import '@odx/design-tokens/css';
// usage with JS
import { token, tokens } from '@odx/design-tokens';
/**
* @param {string} id
* @param {'.'|'light'|'dark'} [mode='.'] - optional
* @param {boolean} [resolveVariables=false] - optional
* */
token('color.background.primary.rest', '.', false);
// JSON import
import tokens from '@odx/design-tokens/tokens.json' with { type: 'json' };
// DTCG JSON import
import dtcgTokens from '@odx/design-tokens/dtcg/tokens.json' with { type: 'json' };
import dtcgPalette from '@odx/design-tokens/dtcg/palette.json' with { type: 'json' };European Accessibility Act (EAA) Conformity
Using CSS classes
To enable EAA compliant colors, add the .odx-eaa-compliant class to an element.
<html class="odx-eaa-compliant">
<!-- Your content here will use EAA compliant colors -->
</html>Using JavaScript
import { enableEAAConformity } from '@odx/design-tokens';
enableEAAConformity(document.documentElement, true | false);Light/Dark mode support
Using CSS classes
To enable dark mode styles, add the .odx-dark-mode class to an element.
<html class="odx-dark-mode">
<!-- Your content here will use dark mode styles -->
</html>To enable light mode styles, add the .odx-light-mode class to an element.
<html class="odx-light-mode">
<!-- Your content here will use light mode styles -->
</html>Using JavaScript
import { applyDarkMode, darkModeClass, lightModeClass } from '@odx/design-tokens';
applyDarkMode(document.documentElement, true | false | 'auto');
// Class name constants
document.documentElement.classList.toggle(darkModeClass | lightModeClass);Documentation
For detailed documentation on how to use the @odx/design-tokens package, including examples and best practices, please visit our documentation.
Contact
For questions, feedback, or support, please reach out to us through our contact page.
