Twin blends the magic of Tailwind with the flexibility of css-in-js



Demo twin on CodeSandbox →

---

Style jsx elements using Tailwind classes:

1import 'twin.macro'
2
3const Input = () => <input tw="border hover:border-black" />

Nest Twin’s tw import within a css prop to add conditional styles:

1import tw from 'twin.macro'
2
3const Input = ({ hasHover }) => (
4  <input css={[tw`border`, hasHover && tw`hover:border-black`]} />
5)

Or mix sass styles with the css import:

1import tw, { css } from 'twin.macro'
2
3const hoverStyles = css`
4  &:hover {
5    border-color: black;
6    ${tw`text-black`}
7  }
8`
9const Input = ({ hasHover }) => (
10  <input css={[tw`border`, hasHover && hoverStyles]} />
11)

Styled Components

You can also use the tw import to create and style new components:

1import tw from 'twin.macro'
2
3const Input = tw.input`border hover:border-black`

And clone and style existing components:

1const PurpleInput = tw(Input)`border-purple-500`

Switch to the styled import to add conditional styling:

1import tw, { styled } from 'twin.macro'
2
3const StyledInput = styled.input(({ hasBorder }) => [
4  `color: black;`,
5  hasBorder && tw`border-purple-500`,
6])
7const Input = () => <StyledInput hasBorder />

Or use backticks to mix with sass styles:

1import tw, { styled } from 'twin.macro'
2
3const StyledInput = styled.input`
4  color: black;
5  ${({ hasBorder }) => hasBorder && tw`border-purple-500`}
6`
7const Input = () => <StyledInput hasBorder />

How it works

When babel runs over your javascript or typescript files at compile time, twin grabs your classes and converts them into css objects. These css objects are then passed into your chosen css-in-js library without the need for an extra client-side bundle:

1import tw from 'twin.macro'
2
3tw`text-sm md:text-lg`
4
5// ↓ ↓ ↓ ↓ ↓ ↓
6
7{
8  fontSize: '0.875rem',
9  '@media (min-width: 768px)': {
10    fontSize: '1.125rem',
11  },
12}

Features

👌 Simple imports - Twin collapses imports from common styling libraries into a single import:

1+ import tw, { styled, css } from 'twin.macro'
2- import tw from 'twin.macro'
3- import styled from '@emotion/styled'
4- import css from '@emotion/react'

🐹 Adds no size to your build - Twin converts the classes you’ve used into css objects using Babel and then compiles away, leaving no runtime code

🛎 Helpful suggestions for mistypings - Twin chimes in with class and variant values from your Tailwind config:

1✕ ml-7 was not found
2
3Try one of these classes:
4ml-0 [0] / ml-1 [0.25rem] / ml-2 [0.5rem] / ml-3 [0.75rem] / ml-4 [1rem] / ml-5 [1.25rem] / ml-6 [1.5rem]
5ml-8 [2rem] / ml-10 [2.5rem] / ml-12 [3rem] / ml-16 [4rem] / ml-20 [5rem] / ml-24 [6rem] / ml-32 [8rem]
6ml-40 [10rem] / ml-48 [12rem] / ml-56 [14rem] / ml-64 [16rem] / ml-auto [auto] / ml-px [1px]

💡 Works with the official tailwind vscode plugin - Avoid having to look up your classes with auto-completions straight from your Tailwind config - See setup instructions →

🚥 Over 40 variants to prefix on your classes - The prefixes are “always on” and available for your classes

• Prefix with hocus: to style hover + focus at the same time
• Style form field states with checked:, invalid: and required:
• Stack up variants whenever you need them sm:hover:first:bg-black

Check out the full list of variants →

🍱 Apply variants to multiple classes at once with variant groups

1import 'twin.macro'
2
3const interactionStyles = () => (
4  <div tw="hover:(text-black underline) focus:(text-blue-500 underline)" />
5)
6
7const mediaStyles = () => <div tw="sm:(w-4 mt-3) lg:(w-8 mt-6)" />
8
9const pseudoElementStyles = () => <div tw="before:(block w-10 h-10 bg-black)" />
10
11const stackedVariants = () => <div tw="sm:hover:(bg-black text-white)" />
12
13const groupsInGroups = () => <div tw="sm:(bg-black hover:(bg-white w-10))" />

👑 Add vanilla css that integrates with twins features

1const setCssVariables = () => <div tw="--base-color[#C0FFEE]" />
2
3const customGridProperties = () => <div tw="grid-area[1 / 1 / 4 / 2]" />
4
5const vendorPrefixes = () => <div tw="-webkit-mask-image[url(mask.png)]" />

🖌️ Use the theme import to add values from your tailwind config

1import { css, theme } from 'twin.macro'
2
3const Input = () => <input css={css({ color: theme`colors.purple.500` })} />

See more examples using the theme import →

💥 Add !important to any class with a trailing or leading bang!

1<div tw="hidden!" /> || <div tw="!hidden" />
2// ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓
3<div css={{ "display": "none !important" }} />

Add !important to multiple classes with bracket groups:

1<div tw="(hidden ml-auto)!" />
2// ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓
3<div css={{ "display": "none !important", "marginLeft": "auto !important" }} />

Get started

Twin works within many modern stacks - take a look at these examples to get started:

App build tools and libraries

• Parcel
  styled-components / emotion / emotion (ts)
• Webpack
  styled-components (ts) / emotion (ts)
• Preact
  styled-components / emotion / goober
• Create React App
  styled-components / emotion
• Snowpack
  styled-components / styled-components (ts) / emotion / emotion (ts)
• Vite
  styled-components (ts) / emotion (ts)

Advanced frameworks

• Gatsby
  styled-components / emotion
• Next.js
  styled-components / emotion / emotion (ts) 🎉 / stitches (ts)
• Blitz.js
  emotion (ts) 🎉
• Laravel
  styled-components (ts)

Component libraries

• Storybook
  styled-components (ts) / emotion
• yarn/npm workspaces + Next.js + shared ui components
  styled-components
• Yarn workspaces + Rollup
  emotion
• HeadlessUI (ts) 🎉

🎉 : Fresh example

Community

Drop into our Discord server for announcements, help and styling chat.

Resources

• 🔥 Docs: The prop styling guide - A must-read guide to level up on prop styling
• 🔥 Docs: The styled component guide - A must-read guide on getting productive with styled components
• Docs: Options - Learn about the features you can tweak via the twin config
• Plugin: babel-plugin-twin - Use the tw and css props without adding an import
• Example: Advanced theming - Add custom theming the right way using css variables
• Example: React + Tailwind breakpoint syncing - Sync your tailwind.config.js breakpoints with react
• Helpers: Twin VSCode snippits - For devs who want to type less
• Plugins: VSCode plugins - VScode plugins that work with twin
• Article: "Why I Love Tailwind" by Max Stoiber - Max (inventor of styled-components) shares his thoughts on twin

Special thanks

This project stemmed from babel-plugin-tailwind-components so a big shout out goes to Brad Cornes for the amazing work he produced. Styling with tailwind.macro has been such a pleasure.