Project Clarity is an open source design system that brings together UX guidelines, an HTML/CSS framework, Angular components, and Web Components. This repository includes everything you need to build, customize, test, and deploy Clarity. For complete documentation, visit the Clarity website.
Clarity is published as five npm packages:
- Contains the Web Components that work in any JavaScript framework.
- Contains shims for core usage in Angular environment
- Contains the static styles for building HTML components.
- Contains the
Angular components. This package depends on
@clr/ui
for styles. - Our open source sans-serif typeface.
For documentation on the Clarity Design System, including a list of components and example usage, see our website.
The Clarity project team welcomes contributions from the community. For more detailed information, see CONTRIBUTING.md.
- The Clarity Design System is licensed under the MIT license.
- The font is licensed under the Open Font License (OFL).
If you find a bug or want to request a new feature, please open a GitHub issue.
Include a link to the reproduction scenario you created by forking one of the Clarity Stackblitz Templates for the version you are using at Clarity StackBlitz templates.
The team supports up to 2 versions behind the latest one.
For questions, ideas, or just reaching out to the team feel free to open a discussion in our GitHub Disscussion section.