Skip to content

Latest commit

 

History

History
27 lines (17 loc) · 2.34 KB

README.md

File metadata and controls

27 lines (17 loc) · 2.34 KB
Raw

Patternfly Design Tokens

Export tokens from Figma

Information about exporting tokens from the Figma Design Tokens & Styles library is with the custom exporter.

Usage

Once the design token JSON files are exported from Figma to the tokens directories, use yarn build:scss to build the SCSS files to the /build directory

By default yarn build:scss outputs the SCSS with :root as a selector, but you can also pass the --selector flag (or just -s for short) and specify any selector you want, i.e. yarn build:scss -s .foo will replace the :root selector with .foo in the generated SCSS files.

To generate token variables for PatternFly core, use

yarn build:scss -s "@mixin pf-v6-tokens"

yarn build:docs and yarn serve:docs will build and run the docs locally.

Note

We are temporarily pushing the built SCSS files to the repo for ease of access. Additional PRs should rebuild and repush updated SCSS files if they would be affected by the PR changes, to keep them up to date.

Docs build

Whenever yarn build:docs is executed:

  • the build:scss script is run which transforms tokens pulled from Figma (split into separate token json files in the /tokens directory) into combined default and dark theme files (in addition to the .scss files within build/css).
  • The two new json files (token-layers-default.json and token-layers-dark.json) are stored in the patternfly-docs/content directory.
  • The code for generating the table containing all tokens is the tokensTable.js, which combines the default and dark theme json tokens into one object and consumes it as data.
  • Ultimately, the markdown file which is rendering the docs is all-patternfly-tokens.md. This markdown file imports the tokensTable.js and takes the token theme files as props.