Official ClickHouse design system react library
npm install @clickhouse/click-ui
src="./.repo/images/banner.jpg?202601211122"
/>
Click UI is the ClickHouse design system and component library. Our aim with Click UI is to provide an accessible, theme-able, modern, and attractive interface with which to experience the speed and power of ClickHouse.
You can find the official docs for the Click UI design system and component library at clickhouse.design/click-ui.
* Requirements
* Quick Start
* Development
- Generating design tokens
- Local development
* Tests
- Functional tests
- Visual regression tests
* Storybook
- Stories development server
- Public static site
* Releases and Versions
- Nodejs (>= 22.12.x) as runtime
- Yarn (>= 4.5.3) for development, any other package manager in a host project
Install the package via npm or your favourite package manager:
``sh`
npm i @clickhouse/click-ui@latest
To use Click UI, you must wrap your application in the provider. This ensures styles and themes are applied correctly across all components.
`ts
import { ClickUIProvider, Title, Text } from '@clickhouse/click-ui'
function App() {
return (
)
}
`
For more examples, including theme switching and configuration, see the How to use section, or explore our design system at clickhouse.design/click-ui.
The project uses yarn package manager for development.
After cloning the repository change to the work directory and install the dependencies:
`sh`
yarn
Tokens are provided by a style directionary sourced from tokens-studio.
It's expected to have theme tokens provided externally, e.g. Figma tokens-studio output is stored in the repository and a PR's opened. The assets are stored in the directory [./tokens/themes].
Once [./tokens/themes] files are updated, we must regenerate the tokens:
`sh`
yarn generate-tokens
Learn more about tokens-studio here.
We leverage Storybook as our primary development environment and documentation, see Storybook.
You can start the Storybook development server by:
`sh`
yarn dev
We do NOT maintain a separate development environment; our Storybook stories serve as the source of truth for component implementation.
> [!IMPORTANT]
> We operate collaboratively with the Product Design team. While stories reflect the current implementation (live), Figma files remain the source of truth for design research and decision-making. Changes are typically finalized in Figma before being implemented in code to ensure design-sync.
By avoiding local preview files, we ensure that component experimentation happens in isolation; free from application side effects and providing a live look at component interfaces and usage examples at time of writing.
> [!NOTE]
> To ensure stability, we utilize Visual Regression and Unit Testing, see tests. When contributing features or tweaks, you're expected to include or update the relevant tests to maintain stability, e.g. remember the components are consumed by a number of applications.
To get started with the development playground, refer to the Storybook section here.
The package uses vitest and react testing library for tests, e.g. functional tests.
`sh`
yarn test
The project uses Chromatic for visual regression testing of UI components.
It captures screenshots of Storybook and compares them across builds to detect unintended visual changes by:
- Automated visual testing in GitHub CI/CD pipeline, e.g. storybook publish, UI tests
- Leveraging storybook stories
- Provides visual diff reviews and approval workflows
- Helps catch UI bugs
To setup, you must get a team member project token.
Add the token as an environment variable to your environment preference or profile, e.g. ~/.zshrc:
`sh`
export CHROMATIC_PROJECT_TOKEN=
Once ready, you can run tests by:
`sh`
yarn test:chromatic
> [!NOTE]
> Chromatic does NOT generate a report in the terminal due to its cloud nature, which only outputs:
> - Build status, e.g. uploading or testing
> - Link to the cloud runner or dashboard
> - Exit code
If you need quicker iteration feedback, or more testing control during local development, read here
The component library provides a collection of ready-to-use components. We use Storybook to showcase and document our components.
Start the storybook development server:
`sh`
yarn storybook
It'll default to the location http://localhost:6006, if port available.
To build a static version:
`sh`
yarn storybook:build
Once built, you can serve the static files by:
`sh`
yarn storybook:serve
The latest static version's built and deployed automatically when contributing to main of Click UI.
Once deployed it's available publicly at clickhouse.design/click-ui.
Click UI has been tested in NextJS, Gatsby, and Vite. If you run into problems using it in your app, please create an issue and our team will try to answer.
1. Navigate to your app's route and run
npm i @clickhouse/click-ui
or
2. Make sure to wrap your application in the Click UI , without doing this, you may run into issues with styled-components. Once that's done, you'll be able to import the individual components that you want to use on each page. Here's an example of an App.tsx in NextJS.
`typescript
import { ClickUIProvider, Text, ThemeName, Title, Switch } from '@clickhouse/click-ui'
import { useState } from 'react'
function App() {
const [theme, setTheme] = useState
const toggleTheme = () => {
theme === 'dark' ? setTheme('light') : setTheme('dark')
}
return (
onCheckedChange={() => toggleTheme()}
label="Dark mode"
/>
export default App
`
Learn to manage the versioning of changelog entries.
The following is a brief description of available commands to allow a person making a contribution make key decisions about their changes.
It'll generate a changeset, which is effectively two key bits of information:
- A version type which follows semver
- Change information placed in a changelog
Make good use of this simple workflow to help us release new package versions more confidently.
When contributing, declare an intent or describe the changes you're making or adding to a release by executing the changeset:add command.
The wizard will ask a few questions and generate a changelog entry for you:
`sh`
yarn changeset:add
The changesets tool keeps track of all declared changes in the .changeset directory.
Once completed, you must commit the changeset!
To check if your branch contains a changeset:
`sh`
yarn changeset:status
To consume all changesets, and update to the most appropriate semver version and write a friendly changelog based on those changesets, the following command is available:
> [!IMPORTANT]
> Consuming changesets is done automatically in the CI/CD environment. For this reason, you don't have to execute the command, as a contributor your single concern should be adding changesets to any relevant changes.
`sh`
yarn changeset:version
New versions and release notes are available at GitHub Releases.
To create a new release and publish a new version, follow the instructions in publish.md.
We prefer to commit our work following Conventional Commits conventions. Conventional Commits are a simple way to write commit messages that both people and computers can understand. It help us keep track fo changes in a consistent manner, making it easier to see what was added, changed, or fixed in each commit or update.
The commit messages are formatted as [type]/[scope]
The type is a short descriptor indicating the nature of the work (e.g., feat, fix, docs, style, refactor, test, chore). This follows the conventional commit types.
The scope is a more detailed description of the feature or fix. This could be the component or part of the codebase affected by the change.
Here's an example of different conventional commits messages that you must follow:
`txt``
test: 💍 Adding missing tests
feat: 🎸 A new feature
fix: 🐛 A bug fix
chore: 🤖 Build process or auxiliary tool changes
docs: 📝 Documentation only changes
refactor: 💡 A code change that neither fixes a bug or adds a feature
style: 💄 Markup, white-space, formatting, missing semi-colons...