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

tw-styled

v3.0.0

Published

![npm-version](https://img.shields.io/npm/v/tw-styled.svg) [![codecov](https://codecov.io/gh/zhangyu1818/tw-styled/graph/badge.svg?token=Ds8VpqzAwG)](https://codecov.io/gh/zhangyu1818/tw-styled) ![npm bundle size](https://deno.bundlejs.com/badge?q=tw-styl

Downloads

407

Readme

tw-styled

npm-version codecov npm bundle size


tw-styled is a React library for quickly creating reusable components utilizing Tailwind CSS. It provides a straightforward and intuitive API, allowing you to integrate Tailwind CSS into your components seamlessly. This library supports all HTML elements and function components, ensuring that you can style your components effortlessly with the full power of Tailwind CSS at your disposal.

Features

  • 🚀 Efficient Styling: Rapidly create styled components with Tailwind CSS.
  • 💅 Complete Flexibility: Supports all HTML elements and React function components.
  • 🛠️ Simple Integration: A straightforward API for integrating Tailwind CSS into your project.

Prerequisites

Before using tw-styled, ensure that Tailwind CSS is properly integrated into your project. If you haven't already set up Tailwind CSS, please refer to the official Tailwind CSS installation guide.

Installation

Install tw-styled via npm:

npm install tw-styled tailwind-merge

If you need to use tw-styled with a customized merge function without installing the tailwind-merge package:

npm install tw-styled

Getting Started

Using tw-styled with built-in merge functionality

Start by importing the tw function from tw-styled:

import { tw } from 'tw-styled'

Creating Components with Tailwind CSS

Use the tw function to create a component styled with Tailwind CSS classes:

const Button = tw.button`bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded`

or using function component to create a styled component:

const Component = ({ className }) => (
  <div className={className}>Function Component</div>
)

const StyledComponent = tw(
  Component,
)`bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded`

Using Components in Your Project

You can now use the styled component just like any other React component:

function App() {
  return (
    <div className='App'>
      <Button>Click me</Button>
    </div>
  )
}

Using tw-styled with custom classnames merge functionality

import { create } from 'tw-styled/create'

const merge = (classNames, propsClassNames) =>
  `${classNames} ${propsClassNames}`

const tw = create(merge)

API

tw

A Proxy object for creating styled components with Tailwind CSS utility classes. It supports all HTML tags and React function components.

Usage

const StyledComponent = tw.Tag`tailwind-class-names`
const StyledComponent = tw.Tag('tailwind-class-names')

const FunctionComponent = ({ className }) => (
  <div className={className}>Function Component</div>
)

const StyledComponent = tw(FunctionComponent)`tailwind-class-names`
const StyledComponent = tw(FunctionComponent)('tailwind-class-names')
  • Tag: An HTML tag (like div, span, button) or a React function component.
  • tailwind-class-names: A Template String of Tailwind CSS classes.

Contributing

Contributions are always welcome! If you have any suggestions, issues, or want to make improvements, please feel free to open an issue or submit a pull request.

License

MIT