Use With

Lit

Using Twind with Lit

📝 Inspect the example
📓 Consult the API reference
📜 Read the changelog

This guide shows how to use Lit with Twind.

Note

In modern browsers this integration uses Constructable Stylesheet Objects and adoptedStyleSheets for optimal performance. In legacy browsers, it falls back to using separate style elements (one per element instance) that are all kept in sync.

🤝 Compatibility

@twind/with-web-components	lit
`>=1.1.0 <1.2.0`	`>=2.0.0 <3`

📦 Installation

Install from npm
@twind/core and @twind/with-web-components are available on npm and need to be installed together.
sh
```
npm install @twind/core @twind/with-web-components
```

Define the configuration

Using an extra file, twind.config.js, allows some tools like IntelliSense to find your configuration.

twind.config.js

import { defineConfig } from '@twind/core'

export default defineConfig({
  /* @twind/with-web-components will use
   * hashed class names in production by default
   * If you don't want this, uncomment the next line
   */
  // hash: false,
})

Create a Custom Element

install creates a mixin that can be used to enhance elements with a shared stylesheet, generates styles for all used CSS classes and adds this.tw (the twind instance) to the element instance.

The mixin function can be used with several elements — they all will share the same twind instance.

import { LitElement, html } from 'lit'

import install from '@twind/with-web-components'
import config from './twind.config'

const withTwind = install(config)

export class TwindElement extends withTwind(LitElement) {
  override render() {
    return html`<h1 class="text-3xl font-bold underline">Hello world!</h1>`
  }
}

customElements.define('twind-element', TwindElement);

Using typescript and decorators

The mixin function can also be used as a decorator.

Important

Please be aware that typescript will not be able to infer the additional properties (like this.tw) added to the element class.

import { LitElement, html } from 'lit'
import { customElement } from 'lit/decorators.js'

import install from '@twind/with-web-components'
import config from './twind.config'

const withTwind = install(config)

@customElement('twind-element')
@withTwind
export class TwindElement extends LitElement {
  override render() {
    return html`<h1 class="text-3xl font-bold underline">Hello world!</h1>`
  }
}

Optional: Install and configure the recommended presets @twind/preset-autoprefix and @twind/preset-tailwind.

Install the presets

All presets are available on npm.

npm install @twind/preset-autoprefix @twind/preset-tailwind

Configure the presets

Each preset must be added to the presets array in the configuration.

twind.config.js

import { defineConfig } from '@twind/core'
import presetAutoprefix from '@twind/preset-autoprefix'
import presetTailwind from '@twind/preset-tailwind'

export default defineConfig({
  presets: [presetAutoprefix(), presetTailwind()],
})