transformer-attributify-jsx-sg

Support valueless attributify in JSX/TSX.
Using ast-grep to match attributes, Thanks for HerringtonDarkholme.

Benchmark

pnpm run bench

Running "unocss concurrent transform jsx" suite...
benchRegexTransform:
  16 ops/s, ±9.95%   | fastest

benchAstGrepTransform:
  13 ops/s, ±0.34%   | 18.75% slower

benchSwcTransform:
  6 ops/s, ±0.84%    | 62.5% slower

benchBabelTransform:
  2 ops/s, ±1.44%    | slowest, 87.5% slower

Usage

export function Component() {
  return (
    <div text-red text-center text-5xl animate-bounce>
      unocss
    </div>
  )
}

Will be transformed to:

export function Component() {
  return (
    <div text-red="" text-center="" text-5xl="" animate-bounce="">
      unocss
    </div>
  )
}

JSX by default will treat valueless attributes as boolean attributes.

export function Component() {
  return (
    <div text-red={true} text-center={true} text-5xl={true} animate-bounce={true}>
      unocss
    </div>
  )
}

Install

npm i -D transformer-attributify-jsx-sg

// uno.config.ts
import { defineConfig, presetAttributify } from 'unocss'
import transformerAttributifyJsx from 'transformer-attributify-jsx-sg'

export default defineConfig({
  // ...
  presets: [
    // ...
    presetAttributify()
  ],
  transformers: [
    transformerAttributifyJsx(), // <--
  ],
})

Caveats

If you encounter any issues with this package, there is @unocss/transformer-attributify-jsx-babel package that uses Babel to transform JSX.

⚠️ The rules are almost the same as those of preset-attributify, but there are several precautions

<div translate-x-100% /> <!-- cannot end with `%` -->

<div translate-x-[100px] /> <!-- cannot contain `[` or `]` -->

Instead, you may want to use valued attributes instead:

<div translate="x-100%" />

<div translate="x-[100px]" />

Blocklist

This transformer will only transform attributes that are valid UnoCSS utilities. You can also blocklist bypass some attributes from been transformed.

transformerAttributifyJsx({
  blocklist: [/text-[a-zA-Z]*/, 'text-5xl']
})

<div text-red text-center text-5xl animate-bounce>
  unocss
</div>

Will be compiled to:

<div text-red text-center text-5xl animate-bounce="">
  unocss
</div>

License

MIT License © 2022-PRESENT zhiyuanzmj