How to: Setup Lit with Tailwind

1. Create a vite project

To create a vite project, run the following command:

bun create vite@latest

Make sure to select the lit framework when prompted, and use TypeScript.

Once setup, navigate to the project directory and install the required dependencies:

cd my-vite-project
bun install

2. Structure the project

currently, the project structure should have a public and src directory. Vite provides you with and example my-element.ts file in the src directory and an index.html file in the root directory.

First move the index.html file to the src directory.

 .
 ├── 📁 public
 ├── 📂 src
 │   ├── 📁 assets
 │   ├── index.css
+│   ├── index.html
 │   ├── my-element.ts
 │   └── vite-env.d.ts
 ├── .gitignore
-├── index.html
 ├── package.json
 └── tsconfig.json

Now create a lib directory and move the assets. Now create a components folder inside lib and move the my-element.ts file to the lib directory. Finally create a main.ts file in the lib directory and export the my-element.ts file.

 .
+├── 📂 lib
+│   ├── 📁 assets
+│   ├── 📂 components
+│   │   └── my-element.ts
+│   └── main.ts
 ├── 📁 public
 ├── 📂 src
-│   ├── 📁 assets
 │   ├── index.css
 │   ├── index.html
-│   ├── my-element.ts
 │   └── vite-env.d.ts
 ├── .gitignore
 ├── package.json
 └── tsconfig.json

And modify the index.html file to point to the lib/my-element.ts file.

  <head>
    <meta charset="UTF-8" />
    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Vite + Lit + TS</title>
     <link rel="stylesheet" href="/src/index.css" />
+    <script type="module" src="/lib/main.ts"></script>
  </head>

Finally, modify the tsconfig.json file to point to the lib directory.

 {
   "compilerOptions": {
     "target": "ES2020",
     "experimentalDecorators": true,
     "useDefineForClassFields": false,
     "module": "ESNext",
     "lib": ["ES2020", "DOM", "DOM.Iterable"],
     "skipLibCheck": true,

     /* Bundler mode */
     "moduleResolution": "bundler",
     "allowImportingTsExtensions": true,
     "isolatedModules": true,
     "moduleDetection": "force",
     "noEmit": true,

     /* Linting */
     "strict": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "noFallthroughCasesInSwitch": true
   },
+  "include": ["src", "lib"]
 }

3. Create a vite.config.ts file

First lets install the required dependencies:

bun add -D vite-plugin-dts vite-tsconfig-paths

At the root of the project, create a vite.config.ts file and add the following:

import { defineConfig } from "vite";
import { resolve } from "path";
import dts from "vite-plugin-dts";
import tsconfigPaths from "vite-tsconfig-paths";

export default defineConfig({
  plugins: [tsconfigPaths(), dts({ rollupTypes: true })],
  build: {
    copyPublicDir: false,
    lib: {
      entry: resolve(__dirname, "lib/main.ts"),
      name: "MyElement",
      fileName: "my-element",
    },
    rollupOptions: {
      external: ["react", "react-dom", "react/jsx-runtime"],
      output: {
        globals: {
          preserveModules: true,
          react: "React",
          "react-dom": "ReactDOM",
          "react/jsx-runtime": "react/jsx-runtime",
        },
      },
    },
  },
  server: {
    open: "/src/index.html",
  },
});

You can now test building the project by running the following command:

bun run build

And you should see the output in the dist directory. (make sure to add the dist directory to the .gitignore file)

 .
+├── 📂 dist
+│   ├── my-element.d.ts
+│   ├── my-element.js
+│   └── my-element.umd.cjs
 ├── 📁 lib
 ├── 📁 public
 ├── 📁 src
 ├── .gitignore
 ├── package.json
 └── tsconfig.json

Finally, update the package.json file to point to the dist/ files.

{
  "name": "my-lit-element",
- "private": true,
+ "version": "0.0.1",
  "type": "module",
+  "files": [
+   "dist"
+ ],
+ "main": "./dist/my-element.umd.cjs",
+ "module": "./dist/my-element.js",
+ "exports": {
+   ".": {
+     "import": "./dist/my-element.js",
+     "require": "./dist/my-element.umd.cjs"
+   }
+ },
  "scripts": {
    "dev": "vite ",
    "build": "tsc && vite build",
    "preview": "vite preview"
  },
  "dependencies": {
    "lit": "^3.2.0"
  },
  "devDependencies": {
    "typescript": "^5.5.3",
    "vite": "^5.4.1",
    "vite-plugin-dts": "^4.1.0",
    "vite-tsconfig-paths": "^5.0.1"
  }
}

4. Add Tailwind CSS

First install the required dependencies:

bun add -D tailwindcss@latest postcss@latest autoprefixer@latest

Then run the following command to generate the tailwind.config.js and postcss.config.js files:

npx tailwindcss init -p

Now update the tailwind.config.js file to generate content from the lib directory:

 /** @type {import('tailwindcss').Config} */
 export default {
+  content: ["lib/**/*.{ts,html,css,scss}"],
   theme: {
     extend: {},
   },
   plugins: [],
 }

In the lib directory, create a shared folder and add two files: tailwindMixin.ts and tailwindMixin.d.ts. and create a styles folder and add a new file tailwind.global.css.

 .
 ├── 📂 lib
 │   ├── 📁 assets
 │   ├── 📂 components
 │   │   └── my-element.ts
+│   ├── 📂 shared
+│   │   ├── tailwindMixin.d.ts
+│   │   └── tailwindMixin.ts
+│   ├── 📂 styles
+│   │   └── tailwind.global.css
 │   └── main.ts
 ├── 📁 public
 ├── 📁 src
 ├── .gitignore
 ├── package.json
 └── tsconfig.json

tailwindMixin.ts

import { adoptStyles, type LitElement, unsafeCSS } from "lit";
import style from "../styles/tailwind.global.css?inline";

declare global {
  /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
  export type LitMixin<T = unknown> = new (...args: any[]) => T & LitElement;
}

const stylesheet = unsafeCSS(style);

export const TW = <T extends LitMixin>(superClass: T): T =>
  class extends superClass {
    connectedCallback() {
      super.connectedCallback();
      if (this.shadowRoot) adoptStyles(this.shadowRoot, [stylesheet]);
    }
  };

tailwindMixin.d.ts

import { type LitElement } from "lit";
declare global {
  export type LitMixin<T = unknown> = new (...args: any[]) => T & LitElement;
}
export declare const TW: <T extends LitMixin>(superClass: T) => T;

tailwind.global.css

@tailwind base;
@tailwind components;
@tailwind utilities;

5. Using Tailwind CSS in your components

With the mixins in place, you can now import the TW mixin in the my-element.ts file and use it in the class definition and replace the static styles property with the tailwind classes.

 import { LitElement, css, html } from "lit";
 import { customElement, property } from "lit/decorators.js";

+import { TW } from "../shared/tailwindMixin";

+const TwLitElement = TW(LitElement);


 @customElement("my-element")
+export class MyElement extends TwLitElement {
  @property() docsHint = "Click on the Vite and Lit logos to learn more";
  @property({ type: Number }) count = 0;

  render() {
    return html`
+     <div class="flex flex-col justify-center items-center gap-2 w-screen">
+       <div class="flex gap-8">
          <a href="https://vitejs.dev" target="_blank">
+           <img src=${viteLogo} class="size-14" alt="Vite logo" />
          </a>
          <a href="https://lit.dev" target="_blank">
+           <img src=${litLogo} class="size-14" alt="Lit logo" />
          </a>
        </div>
        <slot></slot>
+        <div class="px-8">
          <button
+          class="rounded-lg w-full border border-purple-800 px-5 py-3 font-bold cursor-pointer"
            @click=${this._onClick}
            part="button"
          >
            count is ${this.count}
          </button>
        </div>
+       <p class="text-gray-400">${this.docsHint}</p>
+      </div>
    `;
  }

- static styles = css`

  private _onClick() {
    this.count++;
  }
 }

Now you can run the project and see the tailwind styles applied to the component.

bun run dev

BONUS: make tailwind more useful

Up to this point, you have successfully integrated Tailwind CSS with your Lit and Vite project. However, you can make it more useful by adding some utilities and extending the theme similar to how its done using shadcn/ui.

First, install the required dependencies:

bun add class-variance-authority tailwind-merge clsx

Then lets create a utils.ts file in the lib/shared directory and add the following:

import { type ClassValue, clsx } from "clsx";
import { twMerge } from "tailwind-merge";

export function cn(...inputs: ClassValue[]) {
  return twMerge(clsx(inputs));
}

Next we want to update out vscode settings to use Tailwind CSS IntelliSense and add the classRegex to the settings.

{
  "tailwindCSS.experimental.classRegex": [
    ["cva\\(([^)]*)\\)", "[\"'`]([^\"'`]*).*?[\"'`]"],
    ["cx\\(([^)]*)\\)", "(?:'|\"|`)([^']*)(?:'|\"|`)"]
  ]
}

Now we can extend the theme in the tailwind.config.js file similar to how its done in shadcn/ui:

 /** @type {import('tailwindcss').Config} */
 export default {
   content: ["lib/**/*.{ts,html,css,scss}"],
+  theme: {
+    extend: {
+      colors: {
+        border: "hsl(var(--_border))",
+        input: "hsl(var(--_input))",
+        ring: "hsl(var(--_ring))",
+        background: "hsl(var(--_background))",
+        foreground: "hsl(var(--_foreground))",
+        primary: {
+          DEFAULT: "hsl(var(--_primary))",
+          foreground: "hsl(var(--_primary-foreground))",
+        },
+        secondary: {
+          DEFAULT: "hsl(var(--_secondary))",
+          foreground: "hsl(var(--_secondary-foreground))",
+        },
+        destructive: {
+          DEFAULT: "hsl(var(--_destructive))",
+          foreground: "hsl(var(--_destructive-foreground))",
+        },
+      },
+    },
+  },
   plugins: [],
 };

Next we can update the tailwind.global.css file to use the pseudo-private properties that can be overridden by user defined css variables:

 @tailwind base;
 @tailwind components;
 @tailwind utilities;

+@layer components {
+  :host {
+    --_background: var(--background, 0 0% 100%);
+    --_foreground: var(--foreground, 222.2 47.4% 11.2%);
+
+    --_primary: var(--primary, 222.2 47.4% 11.2%);
+    --_primary-foreground: var(--primary-foreground, 210 40% 98%);
+
+    --_secondary: var(--secondary210 40% 96.1%);
+    --_secondary-foreground: var(--secondary-foreground, 222.2 47.4% 11.2%);
+
+    --_destructive: var(--destructive, 0 100% 50%);
+    --_destructive-foreground: var(--destructive-foreground, 210 40% 98%);
+
+    --_border: var(--border, 214.3 31.8% 91.4%);
+    --_input: var(--input, 214.3 31.8% 91.4%);
+    --_ring: var(--ring, 215 20.2% 65.1%);
+
+    --_radius: var(--radius, 0.5rem);
+  }
+}
+
+@layer base {
+  * {
+    @apply border-border;
+  }
+}

This setup allows you to use the cva function to apply variants that combine tailwind classes into more meaningful classes and then control the theme using css variables.

<!DOCTYPE html>
<html lang="en">
  <head>
    <script type="module" src="/lib/main.ts"></script>
  </head>
  <body>
    <style>
      :root {
        --destructive: 6 93% 71%;
        --destructive-foreground: 0 0 0%;
      }
    </style>
    <my-element variant="destructive" size="lg">
      <h1>Vite + Lit</h1>
    </my-element>
  </body>
</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

How to: Setup Lit with Tailwind

1. Create a vite project

2. Structure the project

3. Create a vite.config.ts file

4. Add Tailwind CSS

tailwindMixin.ts

tailwindMixin.d.ts

tailwind.global.css

5. Using Tailwind CSS in your components

BONUS: make tailwind more useful

About

Releases

Packages

Languages

Name		Name	Last commit message	Last commit date
Latest commit History 4 Commits
lib		lib
public		public
src		src
.gitattributes		.gitattributes
.gitignore		.gitignore
README.md		README.md
bun.lockb		bun.lockb
package.json		package.json
postcss.config.js		postcss.config.js
tailwind.config.js		tailwind.config.js
tsconfig.json		tsconfig.json
vite.config.js		vite.config.js

lloydrichards/base_lit-with-tailwind

Folders and files

Latest commit

History

Repository files navigation

How to: Setup Lit with Tailwind

1. Create a vite project

2. Structure the project

3. Create a vite.config.ts file

4. Add Tailwind CSS

tailwindMixin.ts

tailwindMixin.d.ts

tailwind.global.css

5. Using Tailwind CSS in your components

BONUS: make tailwind more useful

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages