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

clomp

v1.0.2

Published

A class name composer that helps you style your components with utility styles. It's like styled-components for CSS utility frameworks.

Downloads

11

Readme

Clomp is a class name composer for React that allows you to use CSS utility frameworks in a more readable way. You can use it with any class names, but it was designed specifically with Tailwind CSS in mind.

Example

This example illustrates how much more readable an element with a lot of utility classes can be. To see examples in code, see the Jest tests in src/constructClomp.spec.js while we work on making more useful examples.

import React from "react";

// Without Clomp

const NavItem = (props) => (
  <a className="h-full text-gray-500 p-8 hover:text-gray-900 sm:p-4 sm:hover:border-8 sm:hover:background-red-500 sm:hover:animate-ping">
    {props.children}
  </a>
);

// With Clomp

import { clomp } from "clomp";

const NavItem = clomp.a`
  h-full
  text-gray-500
  p-8

  hover:
    text-gray-900

  sm:
    p-4

    hover:
      border-8
      background-red-500
      animate-ping
`;

// Using the component

function Nav(props) {
  return (
    <nav>
      <NavItem href="/">Home</NavItem>
      <NavItem href="/contact">Contact</NavItem>
      <NavItem href="/about">About</NavItem>
    </nav>
  );
}

Installation

To use Clomp, install it using the Node Package Manager.

npm install --save clomp

Usage

You can use Clomp similarly to styled-components. In the below example, we'll use a few of Tailwind CSS's utility classes to make a navigation item listing.

Basic Usage

import React from "react";
import { clomp } from "clomp";

const NavItem = clomp.a`
  h-full
  text-gray-500
  p-8

  hover:
    text-gray-900

  sm:
    p-4

    hover:
      border-8
      background-red-500
      animate-ping
`;

function Nav(props) {
  return (
    <nav>
      <NavItem href="/">Home</NavItem>
      <NavItem href="/contact">Contact</NavItem>
      <NavItem href="/about">About</NavItem>
    </nav>
  );
}

Props-Dependent Usage

Any escaped expressions in the template string are assumed to be functions, and are passed any provided props.

const NavItem = clomp.a`
  h-full
  text-gray-500
  p-8

  hover:
    text-gray-900

  sm:
    p-4

    hover:
      border-8
      background-red-500
      animate-ping

  ${({ selected }) =>
    selected
      ? `
    text-blue-500
  `
      : `
    text-gray-500
  `}
`;

function Nav(props) {
  return (
    <nav>
      <NavItem selected href="/">
        Home
      </NavItem>
      <NavItem href="/contact">Contact</NavItem>
      <NavItem href="/about">About</NavItem>
    </nav>
  );
}

Usage with Existing Components

You can use existing components with Clomp, much like you can with styled-components.

import NavItem from "./nav-item";

function Nav(props) {
  return (
    <nav>
      <NavItem selected href="/">
        Home
      </NavItem>
      <NavItem href="/contact">Contact</NavItem>
      <NavItem href="/about">About</NavItem>
    </nav>
  );
}

const StyledNav = clomp(Nav)`
  flex
  flex-col
  
  sm:
    flex-row
`;