Chromatic indexes and versions your components in a searchable library. You can browse components and stories across branches and past builds from the web app. That helps teams discover existing work to reuse and reference “prior art”.
The library screen visualizes the latest components on a branch-by-branch basis. Browse existing components to reuse or reference. Use the branch picker to find branch-specific components.
- Identify changes by comparing historical commits and branches
- Share the library with teammates
- Browse existing components for re-use
Components and their stories are securely indexed each commit and branch. Use the component screen to demo components without needing to switch branches, pull code, or Git. It’s your window into the metadata and variations of the component. You can also share a link to this screen to get feedback.
- Canvas: Interact with the real component code to reproduce behavior
- Snapshot: Verify the image snapshots used for cross-browser UI Tests
- Docs: Browse API and usage documentation created by Storybook Docs.
Direct access to your Storybook
Your Storybook is published on our secure CDN. Published Storybooks are private by default with access restricted to logged in collaborators. Visibility can be set to public if desired.
Chromatic generates a permalink for the latest uploaded Storybook on a given branch. That makes it easy to share with your teammates or link to from docs.
Link to specific branches
When you’re linking to a library or component on Chromatic, it can be useful to link to the latest version on a
branch rather than a specific build. To do so, add the
branch=foo query parameter the the url.
If you’re documenting components outside of Storybook, you may be able to embed interactive stories. This works on many platforms that support the oEmbed specification.
Next: Automate with CI
Now that you learned how UI components are documented in Chromatic, let’s see how to integrate Chromatic into your continuous integration pipeline and get PR status checks.
Why is my Storybook failing to load in Chromatic's Canvas tab?
If your stories make use of non-HTTPS content (for instance, images), the iframe rendering your stories will fail to load, as modern browsers do not allow mixed content (HTTP content sources included within HTTPS pages).
To fix this, ensure all resources used by your stories are served via HTTPS.
Chromatic renders your published stories in an iframe. Due to browser security restrictions, your components and stories cannot reference
window.top. If you’re trying to communicate with the Storybook manager UI, it’s better to use “channels.” Storybook provides the useChannel API for this purpose.
isChromatic(). We provide the
isChromaticutility to “detect” when a story is rendered inside of Chromatic.
window.topreferences in a