0.1.18 • Published 10 months ago

@tailwindcss/jit v0.1.18

Weekly downloads
7
License
MIT
Repository
github
Last release
10 months ago

Overview

An experimental just-in-time compiler for Tailwind CSS that generates your styles on-demand as you author your templates instead of generating everything in advance at initial build time.

This comes with a lot of advantages:

  • Lightning fast build times. Tailwind can take 3–8s to initially compile using our CLI, and upwards of 30–45s in webpack projects because webpack struggles with large CSS files. This library can compile even the biggest projects in about 800ms (with incremental rebuilds as fast as 3ms), no matter what build tool you're using.
  • Every variant is enabled out of the box. Variants like focus-visible, active, disabled, and others are not normally enabled by default due to file-size considerations. Since this library generates styles on demand, you can use any variant you want, whenever you want. You can even stack them like sm:hover:active:disabled:opacity-75. Never configure your variants again.
  • Generate arbitrary styles without writing custom CSS. Ever needed some ultra-specific value that wasn't part of your design system, like top: -113px for a quirky background image? Since styles are generated on demand, you can just generate a utility for this as needed using square bracket notation like top-[-113px]. Works with variants too, like md:top-[-113px].
  • Your CSS is identical in development and production. Since styles are generated as they are needed, you don't need to purge unused styles for production, which means you see the exact same CSS in all environments. Never worry about accidentally purging an important style in production again.
  • Better browser performance in development. Since development builds are as small as production builds, the browser doesn't have to parse and manage multiple megabytes of pre-generated CSS. In projects with heavily extended configurations this makes dev tools a lot more responsive.

To see it in action, watch our announcement video.

Getting started

Install @tailwindcss/jit from npm:

npm install -D @tailwindcss/jit tailwindcss postcss

The existing tailwindcss library is a peer-dependency of @tailwindcss/jit, and is also needed for compatibility with Tailwind plugins.

Add @tailwindcss/jit to your PostCSS configuration (instead of tailwindcss):

  // postcss.config.js
  module.exports = {
    plugins: {
      '@tailwindcss/jit': {},
      autoprefixer: {},
    }
  }

If you are using autoprefixer, make sure you are on the latest version using npm install -D autoprefixer@latest — there's a bug in older versions that makes it incompatible with this library.

Configure the purge option in your tailwind.config.js file with all of your template paths:

// tailwind.config.js
module.exports = {
  purge: [
    './public/**/*.html',
    './src/**/*.{js,jsx,ts,tsx,vue}',
  ],
  theme: {
    // ...
  }
  // ...
}

Now start your dev server or build tool as you normally would and you're good to go.

Make sure you set NODE_ENV=development if you are running a watcher, or Tailwind won't watch your template files for changes. Set NODE_ENV=production for one-off builds.

If you want to control whether Tailwind watches files or not more explicitly, set TAILWIND_MODE=watch or TAILWIND_MODE=build to override the default NODE_ENV-based behavior.

For example if you want to do one-off builds with NODE_ENV=development, explicitly set TAILWIND_MODE=build so that Tailwind knows you are just doing a one-off build and doesn't hang.

Documentation

This library is simply a new internal engine for Tailwind CSS, so for a complete API reference visit the official Tailwind CSS documentation.

The on-demand nature of this new engine does afford some new features that weren't possible before, which you can learn about below.

All variants are enabled out of the box

Since styles are generated on-demand, there's no need to configure which variants are available for each core plugin.

<input class="disabled:opacity-75">

You can use variants like focus-visible, active, disabled, even, and more in combination with any utility, without making any changes to your tailwind.config.js file.

Stackable variants

All variants can be combined together to easily target very specific situations without writing custom CSS.

<button class="md:dark:disabled:focus:hover:bg-gray-400">

Arbitrary value support

Many utilities support arbitrary values using a new square bracket notation to indicate that you're "breaking out" of your design system.

<!-- Sizes and positioning -->
<img class="absolute w-[762px] h-[918px] top-[-325px] right-[62px] md:top-[-400px] md:right-[80px]" src="/crazy-background-image.png">

<!-- Colors -->
<button class="bg-[#1da1f1]">Share on Twitter</button>

<!-- Complex grids -->
<div class="grid-cols-[1fr,700px,2fr]">
  <!-- ... -->
</div>

This is very useful for building pixel-perfect designs where there are a few elements that need hyper-specific styles, like a carefully positioned background image on a marketing site.

We'll likely add some form of "strict mode" in the future for power-hungry team leads who don't trust their colleagues to use this feature responsibly.

Built-in important modifier

You can make any utility important by adding a ! character to the beginning:

<p class="font-bold !font-medium">
  This will be medium even though bold comes later in the CSS.
</p>

The ! always goes at the beginning of the utility name, after any variants, but before any prefix:

- !sm:hover:tw-font-bold
+ sm:hover:!tw-font-bold

This can be useful in rare situations where you need to increase specificity because you're at war with some styles you don't control.

Known limitations

This library is very close to feature parity with tailwindcss currently and for most projects I bet you'll find it works exactly as you'd expect.

There are a few items still on our todo list though that we are actively working on:

  • Advanced PurgeCSS options like safelist aren't supported yet since we aren't actually using PurgeCSS. We'll add a way to safelist classes for sure though. For now, a safelist.txt file somewhere in your project with all the classes you want to safelist will work fine.
  • You can only @apply classes that are part of core, generated by plugins, or defined within a @layer rule. You can't @apply arbitrary CSS classes that aren't defined within a @layer rule.
  • Currently the JIT project only supports PostCSS 8. We may do a compat build like we do for Tailwind, but it isn't a priority right now.

If you run into any other issues or find any bugs, please open an issue so we can fix it.

Roadmap

Eventually we plan to merge this project with tailwindcss and expose it via an option in your tailwind.config.js file, something like this:

// tailwind.config.js
module.exports = {
  mode: 'jit',
  purge: [
    // ...
  ],
  theme: {
    // ...
  }
  // ...
}

Once it's been heavily tested by the community and we've worked out any kinks, we hope to make it the default mode for Tailwind CSS v3.0 later this year.

We'll always provide a mode: 'aot' option for people who want to generate the stylesheet in advance and purge later — we'll need that ourselves for our CDN builds.

License

This library is MIT licensed.

0.1.18

10 months ago

0.1.17

10 months ago

0.1.16

10 months ago

0.1.14

10 months ago

0.1.15

10 months ago

0.1.11

10 months ago

0.1.12

10 months ago

0.1.13

10 months ago

0.1.10

10 months ago

0.1.9

10 months ago

0.1.8

10 months ago

0.1.7

10 months ago

0.1.6

10 months ago

0.1.5

10 months ago

0.1.4

10 months ago

0.1.2

10 months ago

0.1.3

10 months ago

0.1.0

11 months ago

0.1.1

10 months ago

0.0.0-15ee4ac4dc

11 months ago

0.0.0-3cf38849c

11 months ago

0.0.0-87def1987

11 months ago

0.0.0-d7396a7a8

11 months ago

0.0.0-98ae69d9c

11 months ago

0.0.0-63a0e75bd

11 months ago

0.0.0-b9f579622

11 months ago

0.0.0-3daffbac5

11 months ago

0.0.0-388725926

11 months ago

0.0.0-8cd714ad6

11 months ago

0.0.0-dc5cc014b

11 months ago

0.0.0-96850daae

11 months ago

0.0.0-6fa76ee3d

11 months ago

0.0.0-9243dd33

11 months ago

0.0.0-9ca89f65

11 months ago

0.0.0-f4e6e109b

11 months ago

0.0.0-bc8b5a4ec

11 months ago

0.0.0-09e7830b9c

11 months ago

0.0.0-ae630ba6e

11 months ago

0.0.0-24fb8553

11 months ago

0.0.0-c5ce40c7f2

11 months ago

0.0.0-c5ce40c7f

11 months ago

0.0.0-11460c545f

11 months ago

0.0.0-bb3026c854

11 months ago

0.0.0-f5d1f58e

11 months ago