twind

twind

---

READ THIS FIRST!

Twind v1 is still in beta. Expect bugs!

Twind v1 is a complete rewrite aiming to be compatible with Tailwind v3 classes

---

Tailwind right in the browser without any build step.

CDN Usage

Add this line to your index.html:

<script src="https://cdn.jsdelivr.net/npm/twind@next"></script>

To configure Twind (optional):

<script>
  twind.setup({
    presets: [
      // custom presets...
    ],
    theme: {
      extend: {
        colors: {
          clifford: '#da373d',
        }
      }
    }
    rules: [
      // custom rules...
    ],
    // ...
  })
</script>

By default, @twind/autoprefix and @twind/preset-tailwind will be applied.

CDN Builds

Core

Without any preset:

<script src="https://cdn.jsdelivr.net/npm/twind@next/core.global.js"></script>

Tailwind

With @twind/autoprefix and @twind/preset-tailwind:

<script src="https://cdn.jsdelivr.net/npm/twind@next"></script>

Mini

With @twind/autoprefix and @twind/preset-mini:

<script src="https://cdn.jsdelivr.net/npm/twind@next/mini.global.js"></script>

Bundler Usage

npm i twind

import { setup } from 'twind'

setup({
  /* options */
})

API

Everything from @twind/core is available.

setup

Can be called as many times as you want.

cx (from @twind/core)

import { cx } from 'twind'

// Set a className
element.className = cx`
  underline
  /* multi
    line
    comment
  */
  hover:focus:!{
    sm:{italic why}
    lg:-{px}
    -mx-1
  }
  // Position
  !top-1 !-bottom-2
  text-{xl black}
`

tw

TDB

apply

TDB

theme

TDB