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

react-classnamed-components

v0.1.5

Published

Create React components easily with classNames

Downloads

14

Readme

This package is inspired by styled-components and classnames.

Installation

To download react-classnamed-components run:

npm i react-classnamed-components

API

import e from 'react-classnamed-components';

// basic
const Box = e("div")`class-1 class-2`

// with element shortcut
const Box = e.div`class-1 class-2`

// with classNames condition
const Box = e.div(props=>["class-1", "class-2",{"class-error": props.hasError}])

// with default attributes/props
const Input = e.input.attrs({ type: "password" })`class-1 class-2`

// with default attributes + classNames conditions
const Input = e.input.attrs({type: "password"})(props => ["class-2 class-2], {"class-error": props.hasError}])

Demo (CodeSandbox)

Visit these CodeSandbox examples, where you can play with the package.

Getting Started

To understand the potential of this package, let's import inside our CSS the Tailwind CDN

@import "https://unpkg.com/tailwindcss@^1.0/dist/tailwind.min.css";

Simple Button

Let's create a simple button component, same as the example from Tailwind's website https://tailwindcss.com/components/buttons/#simple

import e from "react-classnamed-components"
const Button = e.button`bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded"`
<button>Click Me!</button>

Button with Props

We can use the component props to change the classNames of our component.

import e from 'react-classnamed-components';
const Button = e.button(props => ["bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4",
  {
     "rounded": !props.rounded.
     "rounded-full": porps.rounded
  }
];
<button rounded>Click Me!</button>

Button With Color Variants

This is a more complex component, where we use props to change the component Colors and States.

import e from "react-classnamed-components"

const ButtonVariants = {
  default: {
    border: "border-gray-600",
    text: "text-gray-600",
    bg: "bg-gray-600",
    bgHover: "hover:bg-gray-700"
  },

  red: {
    border: "border-red-600",
    text: "text-red-600",
    bg: "bg-red-600",
    bgHover: "hover:bg-red-700"
  },

  blue: {
    border: "border-blue-500",
    text: "text-blue-500",
    bg: "bg-blue-500",
    bgHover: "hover:bg-blue-700"
  }
}

const Button = e.button((props) => {
  const variant = ButtonVariants[props.variant]

  return [
    "shadow-lg font-bold py-2 px-4",
    {
      "rounded-full": props.rounded,
      [`text-white rounded ${variant.bg} ${variant.bgHover}`]: !props.outline,
      [`bg-transparent border ${variant.border} ${variant.text} ${variant.bgHover} hover:text-white `]: props.outline,
      "opacity-50 cursor-not-allowed": props.disabled
    }
  ]
})

export default Button
<button>Click Me!</button>
<button variant="red" rounded>Click Me!</button>
<button variant="blue" outline>Click Me!</button>
<button variant="blue" disabled>Click Me!</button>

ToDo

  • [x] Write tests
  • [x] Typescript support
  • [x] Forward ref
  • [x] Examples folder of common use cases
  • [x] Refactor Code
  • [ ] Own implemention of classnames package

More Examples

  • [x] Tailwind CSS
  • [ ] Styled-components
  • [ ] Emotion
  • [ ] CSS modules