The CBP Design System (1.0) exists to provide a unifying user experience and reduce redundant front-end code within the US Customs and Border Protection enterprise suite of applications and websites. This is the next evolution of our first effort, the CBP Theme (1.X).
⚠️ The CBP Design System is in BETA release status. Most components have been well-tested and are stable, but breaking changes may be introduced if absolutely necessary (and will be documented as such). New components may be introduced (and marked as such), which require additional testing before considered stable or BETA-worthy.
This project is set up as a monorepo, containing multiple packages. Current efforts are focused on the web components package as the single source of truth from which the React components are generated during the build process.
npm install should be run within each of the packages subdirectories you wish to run locally.
| Package Name | Description |
|---|---|
| design-tokens (WIP) | Design Tokens |
| @cbpds/web-components (WIP) | Web components library |
| @cbpds/react-components (WIP) | React components library (for React 18 and lower) |
We welcome contributions, please see our Contribution Policy
Read and follow the steps in the Project Setup Wiki to fork the repo and start contributing!