Core

Overview:

Clarity is an open source design system that combines UX guidelines, design resources, and coding implementations using Web Components. It provides a repository with all the necessary tools for building, customizing, testing, and deploying designs. The Clarity website offers comprehensive documentation for users to refer to.

Features:

• Core: Contains Web Components that can be used with any JavaScript framework.
• CDS Angular: Includes shims for using Clarity Core within Angular environments.
• CDS React: Includes shims for using Clarity Core within React environments.
• Clarity City: An open source sans-serif typeface developed by Clarity.

Installation:

To install Clarity, follow these steps:

1. Go to the Clarity documentation at https://clarity.design/get-started/Documentation.
2. Choose the appropriate npm package version for your needs:
   • npm version core: This package contains the Web Components that can be integrated into any JavaScript framework.
   • npm version cds angular: This package includes shims specifically designed for using Clarity Core with Angular.
   • npm version cds react: This package includes shims specifically designed for using Clarity Core with React.
   • npm version clarity city: This package provides the open source Clarity City sans-serif typeface.
3. Use the npm package manager to install the desired Clarity package. For example:

   npm install @clr/core
   

4. Once installed, you can import and use the Clarity components in your project.

Summary:

Clarity is a versatile open source design system that offers UX guidelines, design resources, and coding implementations through Web Components. It provides various npm packages, including the core components, shims for Angular and React compatibility, and an open source sans-serif typeface. The Clarity website offers documentation, API references, usage guidelines, and support resources for users. The Clarity project team also encourages contributions from the community.