Crayons

Theme by Freshworks

|

Updated: 8 Apr 2025

|

231 Stars

Crayons - A UI Kit comprising of web components for building Freshworks Apps!

Categories

Overview

The Freshworks Crayons is a library of UI components designed to create a consistent and intuitive user interface for all applications. This collection of web components aligns with the Freshworks Design System, ensuring adherence to UX standards. The library includes core components, icons, and internationalization support.

Features

• Core: The core package includes essential UI components for building applications.
• Icons: The icons package provides a collection of customizable icons for use in applications.
• i18n: The i18n package offers internationalization support for multi-language applications.

Installation

To install the Freshworks Crayons library, follow these steps:

1. Refer to the usage guidelines provided here for installation instructions.
2. Choose the desired package from the following options:
   • Core: npm install @freshworks/crayons
   • Icons: npm install @freshworks/crayons-icon
   • i18n: npm install @freshworks/crayons-i18n
3. Include the package in your project by importing it as required.
4. For detailed information, refer to the README.md file of the respective package.

Summary

The Freshworks Crayons library is a comprehensive collection of UI components that enable developers to create visually appealing and user-friendly applications. By adhering to the Freshworks Design System, the library ensures a consistent interface across all apps. With easy installation and comprehensive documentation, developers can seamlessly integrate Freshworks Crayons into their projects.