@quantinuum/documentation-ui

Quantinuum design tokens and React components.

Based on shadcn, an opinionated tailwind theme and radix-ui component generator. Shadcn components have been generated into this repo using the components.json definition and re-exported as a new library.

Development

Basic commands

npm run storybook # Run storybook application to view components.
npm run build-storybook # Build storybook application as static HTML.
npm run build # Build component library with rollup.

Design Tokens

CSS variables are declared in src/tokens.css. Dark mode is enabled when using the attribute data-theme="dark" higher up in the DOM tree. See src/tokens.css for more details.

Semantic release

This package uses semantic-release for creating releases. So that the version numbers are incremented appropriately, commits should conform to the Angular Commit Message Conventions.

A pre-commit hook that enforces this can be installed by running:

pipx install prek
prek install --hook-type commit-msg