{"id":26642559,"url":"https://github.com/freshdesk/crayons","last_synced_at":"2025-03-24T19:01:36.406Z","repository":{"id":36976003,"uuid":"170262745","full_name":"freshworks/crayons","owner":"freshworks","description":"🖍️ Crayons - A UI Kit comprising of web components for building Freshworks Apps!","archived":false,"fork":false,"pushed_at":"2025-02-27T17:12:06.000Z","size":51208,"stargazers_count":225,"open_issues_count":40,"forks_count":63,"subscribers_count":21,"default_branch":"next","last_synced_at":"2025-03-06T11:11:47.367Z","etag":null,"topics":["components","crayons","freshworks","frontend","stenciljs","stenciljs-components","ui","ui-components","uikit","web-components"],"latest_commit_sha":null,"homepage":"https://crayons.freshworks.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/freshworks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-12T06:11:35.000Z","updated_at":"2025-02-27T17:12:10.000Z","dependencies_parsed_at":"2023-09-23T13:15:40.513Z","dependency_job_id":"479f2b3a-ac10-446a-89e1-d4d3b49f8cd2","html_url":"https://github.com/freshworks/crayons","commit_stats":{"total_commits":1840,"total_committers":47,"mean_commits":"39.148936170212764","dds":0.6228260869565218,"last_synced_commit":"13fdc857cfcf980d9b17984bb39c3779533b4075"},"previous_names":["freshdesk/crayons"],"tags_count":433,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freshworks%2Fcrayons","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freshworks%2Fcrayons/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freshworks%2Fcrayons/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freshworks%2Fcrayons/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/freshworks","download_url":"https://codeload.github.com/freshworks/crayons/tar.gz/refs/heads/next","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245334841,"owners_count":20598385,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["components","crayons","freshworks","frontend","stenciljs","stenciljs-components","ui","ui-components","uikit","web-components"],"created_at":"2025-03-24T19:01:23.384Z","updated_at":"2025-03-24T19:01:36.393Z","avatar_url":"https://github.com/freshworks.png","language":"JavaScript","funding_links":[],"categories":["Real World"],"sub_categories":["Design Systems"],"readme":"![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\u0026colorA=16161d\u0026style=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)\n\n# 🖍️ Crayons\n\n[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.\n\n## Packages\n\n| Project   | Package                                                                              | Stable Version                                                                                                                     | Pre-release Version                                                                                                                  | Downloads                                                                                                                                                                         |                     Links                      |\n| --------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------: |\n| **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)           | \u003ca href=\"https://www.npmjs.com/package/@freshworks/crayons\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/npm/dm/@freshworks/crayons.svg\" alt=\"NPM Downloads\" /\u003e\u003c/a\u003e           | [`README.md`](packages/crayons-core/README.md) |\n| **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) | \u003ca href=\"https://www.npmjs.com/package/@freshworks/crayons-icon\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/npm/dm/@freshworks/crayons-icon.svg\" alt=\"NPM Downloads\" /\u003e\u003c/a\u003e | [`README.md`](packages/crayons-icon/README.md) |\n| **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) | \u003ca href=\"https://www.npmjs.com/package/@freshworks/crayons-i18n\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/npm/dm/@freshworks/crayons-i18n.svg\" alt=\"NPM Downloads\" /\u003e\u003c/a\u003e | [`README.md`](packages/crayons-i18n/README.md) |\n\n### Installation\n\nPlease refer to the usage guidelines [here](https://crayons.freshworks.com/introduction/#installation).\n\n### Documentation\n\nYou can refer to the documentation on the [Crayons Website](https://crayons.freshworks.com).\n\n### Framework Wrappers\n\nCrayons 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)\n\n### Development and Contribution\n\nPlease see [here](CONTRIBUTING.md#setup-the-local-environment) for details.\n\n#### Code of Conduct\n\nPlease read the Code of Conduct [here](CODE_OF_CONDUCT.md).\n\n#### Read more\n\nThis project is built with [StencilJS](https://stenciljs.com/). You can check out the following links for further information:\n\n- [Build components](https://stenciljs.com/docs/decorators)\n- [Testing a component](https://stenciljs.com/docs/testing-overview)\n- [Using in different frameworks](https://stenciljs.com/docs/overview)\n\n---\n\nBuilt with ❤ at Freshworks\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreshdesk%2Fcrayons","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffreshdesk%2Fcrayons","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreshdesk%2Fcrayons/lists"}