Giter VIP home page Giter VIP logo

tailwindcss-components's Introduction

tailwindcss-components

GitHub Workflow Status

An easy to use package for creating reusable TailwindCSS components in React.

Features

  • ๐Ÿ›  Typescript Support
  • ๐Ÿ“ฆ Tiny Bundle Size (1.5KB minified, 812B minified + gzipped)
  • ๐Ÿ’จ Rapid Installation
  • ๐Ÿ™‚ Easy to Use

Motivation

I wanted a tool that was easy to use and easy to install so that I could create reusable TailwindCSS components in a clean way with no boilerplate.

Installation

Install tailwindcss-components through your favorite package manager.

npm install tailwindcss-components

or

yarn add tailwindcss-components

Usage

Use the twc object to add styles to JSX tags.

import twc from "tailwindcss-components"

const Header = twc.h1`text-3xl font-semibold text-gray-900`
const Text = twc.p`my-2 leading-7 text-gray-800`

const MyComponent = () => {
  return (
    <div>
      <Header>Tailwind Components</Header>
      <Text>Amazing!</Text>
    </div>
  )
}

Intellisense

You can configure the TailwindCSS Intellisense plugin for VSCode to provide style completion by adding the following to your settings.json file...

"tailwindCSS.experimental.classRegex": ["twc\\.\\w+`([^`]*)"]

How it Works

tailwindcss-components simply passes down the style string into the className prop of the specified JSX tag.

tailwindcss-components's People

Contributors

estebangarcia21 avatar

Stargazers

 avatar  avatar Geoff Donaldson avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.