Skip to main content

Storybook

Every chart and every React component has a Storybook story, and the stories are the demos: browse them at britecharts.github.io/britecharts/storybook.

That page is a composed Storybook. It has an introduction and the changelog of its own, and pulls in two others as sections:

SectionPackageDirect link
Britecharts Core@britecharts/core/storybook/core
Britecharts React@britecharts/react/storybook/react

All three are built and deployed with the documentation on every push to main, so they always show what is on main.

Running them locally​

yarn demos

starts core on port 2001, React on 2002 and the composed shell on 2000. See the contributing guide for the details.

Visual review​

The core and React Storybooks are also published to Chromatic from every pull request, where maintainers review visual changes story by story. That is a review tool, not a public site: the links above are the ones to share.