THIS LIBRARY IS BEING RE-WORKED

clomp aims to solve an opinionated problem of losing the ability to use tagged templates or other functions like styled from styled-components when using class-based styling systems, while also presenting those classes in a way that's easier to read. In its current form, there are a few issues:

• Tailwind scans source files for class names that it needs to include, meaning those class names need to be fully-formed in the source or they may not be included in a production package. An attempt is being made to solve this using a Babel preprocessor and other solutions are being explored
• clomp is React-specific, with no good reason to be. One of the core problems it solves is presenting structured class names in a more readable way, so this functionality will be extracted into its own module for use in any component library/framework or in the absence of one
• Needs type definitions
• clomp needs helper tools of some sort to match functionality like the Tailwind class sorter plugin (these plugins solve real problems, and using clomp without them could make debugging and such harder)

We're working on solving these problems in the coming months. If you're interested in following progress, watch the repository until we make some issues to track these improvements.

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
`;