Red Hat Design Tokens

Design Tokens for Red Hat's Digital Design System.

🚚 Installation

``sh
npm i @rhds/tokens
`

🎭 Usage

We use style-dictionary to transform our tokens into multiple formats and helpers.

$3

Apply defaults to the document root by importing the global stylesheet:
`html


`

$3

Reset a component's styles (preventing inheritance) by adding resetStyles to it's static Constructible Style Sheet list:
`ts
import { resetStyles } from '@rhds/tokens/css/reset.css.js';
import style from './rh-jazz-hands.css';

@customElement('rh-jazz-hands')
export class RhJazzHands extends LitElement {
static readonly styles = [resetStyles, style];
}
`

$3


Import tokens as JavaScript objects:
`js
import { tokens } from '@rhds/tokens';

htmlI'm blue;
`
or for tree-shakable imports:
`js
import { ColorBlue300 } from '@rhds/tokens/values.js';

htmlI'm blue;
`
> :warning: NOTE
>
> We strongly recommend using CSS variables (and accompanying snippets)
wherever, instead of importing tokens as JavaScript objects.

$3

Install the stylelint plugin to automatically correct token values in your files.

See the Stylelint Plugin README for more info.

$3

The experimental 11ty plugin lets you display token values in an 11ty site.

$3


Editor snippets complete prefixes like --rh-color-brand to their CSS custom properties, complete with fallback, e.g.
`css
color: var(--rh-color-brand, #ee0000);
`

They also provide reverse lookup, so if you want to choose between _all_ the tokens with value #e00, you can do so by completing the prefix e00.

Load snippets in VSCode:
Download the VSIX bundle from the releases page.
Or, search the VSCode marketplace for Red Hat Design Tokens

Load snippets in neovim via LuaSnip:
`lua
require 'luasnip.loaders.from_vscode'.lazy_load { paths = {
-- Path to the built project, perhaps in your node_modules
'~/Developer/redhat-ux/red-hat-design-tokens/editor/vscode'
} }
`

$3


Vim users can load the vim-hexokinase plugin to display colour swatches
next to their encoded values in their editor. Use the following config (lua syntax, for neovim users) to configure
hexokinase to display colour values next to colour aliases like {color.brand.red}

`lua
vim.g.Hexokinase_optInPatterns = {
'full_hex', 'triple_hex',
'rgb', 'rgba',
'hsl', 'hsla',
'colour_names',
}

vim.g.Hexokinase_ftOptOutPatterns = {
json = { 'colour_names' },
yaml = { 'colour_names' },
}

vim.g.Hexokinase_palettes = {
-- replace with path to the built tokens package on your drive
vim.fn.expand'~/Developer/redhat-ux/red-hat-design-tokens/editor/neovim/hexokinase.json'
}
``

🏆 Contributing

See CONTRIBUTING.md