npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@carrot-kpi/ui

v0.70.0

Published

Carrot UI is an open source React component library that implements Carrot KPI's design system.

Downloads

48

Readme

Carrot UI

Carrot UI is an open source React component library that implements Carrot KPI's design system.

It includes a collection of prebuilt components that are ready for use in production right out of the box.

The library is generally made to be used on Carrot frontend and templates, but it is free (as in freedom) to use for anyone.

NB: THE LIBRARY CURRRENTLY ONLY SUPPORTS ESM, WITH THE ONLY EXCEPTION BEING THE TAILWIND PRESET, EXPORTED IN BOTH ES AND CJS FORMAT

Tech used

The library is developed in React with Typescript, the styling done through TailwindCSS and the bundling done using Rollup. We have a workflow that tries to keep under control both the overall formatting of the code to keep it consistent and the size of the final bundle (even though it is meant to be used with bundlers that will tree-shake the final result).

Getting started

As a prerequisite, make sure react is currently installed in your project.

For the default (incomplete) installation simply use the following command:

// or
yarn add @carrot-kpi/ui
// or
npm install @carrot-kpi/ui
// or
pnpm install @carrot-kpi/ui

To make the installation complete you can just install the missing fonts used in the library through Fontsource:

pnpm install @fontsource/ibm-plex-mono
pnpm install @carrot-kpi/switzer-font

// or
yarn add @fontsource/ibm-plex-mono
yarn add @carrot-kpi/switzer-font

// or
npm install @fontsource/ibm-plex-mono
npm install @carrot-kpi/switzer-font

// or
pnpm install @fontsource/ibm-plex-mono
pnpm install @carrot-kpi/switzer-font

The library is ready to use after adding the following to your entrypoint:

import "@fontsource/ibm-plex-mono/400.css";
import "@fontsource/ibm-plex-mono/500.css";
import "@fontsource/ibm-plex-mono/700.css";
import "@carrot-kpi/switzer-font/400.css";
import "@carrot-kpi/switzer-font/500.css";
import "@carrot-kpi/switzer-font/700.css";
import "@carrot-kpi/ui/styles.css";

Documentation

The library components are documented using Storybook, but the final result is still not officially published anywhere as of now.

TailwindCSS

The library is styled using TailwindCSS. If you want to extend/change the default styles, this is possible through Tailwind's presets. The library exports its preset, and you can integrate it in your Tailwind config in the following way:

// tailwind.config.js

/** @type {import('tailwindcss').Config} */
module.exports = {
    ...
    presets: [require("@carrot-kpi/ui/tailwind-preset")],
    ...
};