@freshworks/crayons
    TypeScript icon, indicating that this package has built-in type declarations

    2.13.4 • Public • Published

    Release Built With Stencil semantic-release NPM npm

    🖍️ Crayons

    Freshworks Crayons is a library of UI components that help create an intuitive and uniform user interface for all your apps. This collection of Web components helps developers build apps that adhere to the UX standards set by the Freshworks Design System.

    Installation

    Please refer to the usage guidelines here.

    Documentation

    You can refer to the documentation on the Crayons Website.

    Development and Contribution

    • Clone the repo:
    git clone https://github.com/freshworks/crayons
    cd crayons
    npm install
    git config core.hooksPath .git/hooks/
    • To start in dev mode with HMR and Storybook:
    npm run dev
    • To build the components for production, run:
    npm run build:components
    • To run the tests for the components, run:
    npm run test
    • To generate a new component, run:
    npm run generate

    Please see CONTRIBUTING GUIDELINES for more details.

    Code of Conduct

    Please read the Code of Conduct here.

    Naming Components

    When generating components, the custom element tags is prefixed with fw- while the rest of the name is modified to support web component standards. For example, if a component is generated with the name Label, the component that would be generated would be <fw-label/>.

    Read more

    This project is built with StencilJS. You can check out the following links for further information:

    Install

    npm i @freshworks/crayons

    DownloadsWeekly Downloads

    19,291

    Version

    2.13.4

    License

    MIT

    Unpacked Size

    7.68 MB

    Total Files

    568

    Last publish

    Collaborators

    • vinodhmanick
    • mdibrahim
    • arvindan.aswathanarayanan
    • freshworks-dev
    • muthufd
    • prasannanfd
    • sankar-ganesh
    • hrishikesh
    • parsuram-npm
    • rajasegar-c
    • asifahmed
    • ravirajsubramanian
    • adithya_nat
    • freshanand
    • harishkumr