![Release](https://github.com/freshworks/crayons/workflows/Release/badge.svg) ![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square) [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/) ![NPM](https://img.shields.io/npm/l/@freshworks/crayons) ![PRs welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen.svg) ![npm](https://img.shields.io/npm/dm/@freshworks/crayons.svg)

# 🖍️ Crayons

[Freshworks Crayons](https://crayons.freshworks.com) is a library of UI components that help create an intuitive and uniform user interface for all your apps. This collection of [Web components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) helps developers build apps that adhere to the UX standards set by the Freshworks Design System.

## Packages

| Project   | Package                                                                              | Stable Version                                                                                                                     | Pre-release Version                                                                                                                  | Downloads                                                                                                                                                                         |                     Links                      |
| --------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------: |
| **Core**  | [`@freshworks/crayons`](https://www.npmjs.com/package/@freshworks/crayons)           | [![version](https://img.shields.io/npm/v/@freshworks/crayons/v4.svg)](https://www.npmjs.com/package/@freshworks/crayons)           | [![version](https://img.shields.io/npm/v/@freshworks/crayons/next.svg)](https://www.npmjs.com/package/@freshworks/crayons)           | <a href="https://www.npmjs.com/package/@freshworks/crayons" target="_blank"><img src="https://img.shields.io/npm/dm/@freshworks/crayons.svg" alt="NPM Downloads" /></a>           | [`README.md`](packages/crayons-core/README.md) |
| **Icons** | [`@freshworks/crayons-icon`](https://www.npmjs.com/package/@freshworks/crayons-icon) | [![version](https://img.shields.io/npm/v/@freshworks/crayons-icon/v4.svg)](https://www.npmjs.com/package/@freshworks/crayons-icon) | [![version](https://img.shields.io/npm/v/@freshworks/crayons-icon/next.svg)](https://www.npmjs.com/package/@freshworks/crayons-icon) | <a href="https://www.npmjs.com/package/@freshworks/crayons-icon" target="_blank"><img src="https://img.shields.io/npm/dm/@freshworks/crayons-icon.svg" alt="NPM Downloads" /></a> | [`README.md`](packages/crayons-icon/README.md) |
| **i18n**  | [`@freshworks/crayons-i18n`](https://www.npmjs.com/package/@freshworks/crayons-i18n) | [![version](https://img.shields.io/npm/v/@freshworks/crayons-i18n/v4.svg)](https://www.npmjs.com/package/@freshworks/crayons-i18n) | [![version](https://img.shields.io/npm/v/@freshworks/crayons-i18n/next.svg)](https://www.npmjs.com/package/@freshworks/crayons-i18n) | <a href="https://www.npmjs.com/package/@freshworks/crayons-i18n" target="_blank"><img src="https://img.shields.io/npm/dm/@freshworks/crayons-i18n.svg" alt="NPM Downloads" /></a> | [`README.md`](packages/crayons-i18n/README.md) |

### Installation

Please refer to the usage guidelines [here](https://crayons.freshworks.com/introduction/#installation).

### Documentation

You can refer to the documentation on the [Crayons Website](https://crayons.freshworks.com).

### Framework Wrappers

Crayons provides a wrapper for web components for various `Frontend frameworks`. At present a wrapper for **React** is available. For more information, check [here](https://crayons.freshworks.com/frameworks/react)

### Development and Contribution

Please see [here](CONTRIBUTING.md#setup-the-local-environment) for details.

#### Code of Conduct

Please read the Code of Conduct [here](CODE_OF_CONDUCT.md).

#### Read more

This project is built with [StencilJS](https://stenciljs.com/). You can check out the following links for further information:

- [Build components](https://stenciljs.com/docs/decorators)
- [Testing a component](https://stenciljs.com/docs/testing-overview)
- [Using in different frameworks](https://stenciljs.com/docs/overview)

---

Built with ❤ at Freshworks