Lightweight Lit components with shadcn-inspired theming, Tailwind CSS v4 styling, and Lucide icons.
View Live Demo & Interactive Documentation → Explore all components with live examples, copy-paste code snippets, and interactive playgrounds.
- Two Types of Components: Functional components for stateless UI elements (Button, Card, Badge) and Custom elements for components with internal state (theme-toggle, language-selector)
- shadcn/ui Themes: Compatible with shadcn/ui design system. Built-in default and Claude themes. Dark mode support via
darkclass - TypeScript First: Full TypeScript support with type definitions. IDE autocomplete for all components and i18n
- Tailwind CSS v4: Modern styling with the latest Tailwind features
- Lucide Icons: Complete icon set with tree-shaking support
npm install lit @mariozechner/mini-litnpm install -D @tailwindcss/vite// vite.config.ts
import { defineConfig } from "vite";
import tailwindcss from "@tailwindcss/vite";
export default defineConfig({
plugins: [tailwindcss()],
});npm install -D @tailwindcss/cli// package.json scripts
"scripts": {
"dev": "tailwindcss -i ./src/app.css -o ./dist/app.css --watch",
"build": "tailwindcss -i ./src/app.css -o ./dist/app.css --minify"
}/* src/app.css */
/* Import theme (includes dark mode and utilities) */
@import "@mariozechner/mini-lit/styles/themes/default.css";
/* Tell Tailwind to scan mini-lit components */
@source "../node_modules/@mariozechner/mini-lit/dist";
/* Import Tailwind */
@import "tailwindcss";import { html, render } from "lit";
import { Button, Card, Badge, icon } from "@mariozechner/mini-lit";
import { Send } from "lucide";
import "./app.css";
const App = () => html`
<div class="p-8 bg-background text-foreground min-h-screen">
<!-- mini-lit components with internal state are full LitElement instances with custom tags -->
<theme-toggle class="fixed top-4 right-4"></theme-toggle>
<!-- mini-lit components without internal state are functional components returning TemplateResult -->
${Card(html`
<h1 class="text-2xl font-bold mb-4">Hello mini-lit!</h1>
${Button({
children: html`
${icon(Send, "sm")}
<span>Send Message</span>
`,
})}
`)}
</div>
`;
render(App(), document.body);- Buttons - All button variants and states
- Copy Button - Copy text to clipboard
- Download Button - Download files
- Cards - Content containers with header, content, and footer sections
- Separators - Visual dividers
- Split Panel - Resizable layouts
- Dialogs - Modal dialogs
- Inputs - Text, email, password inputs
- Textareas - Multi-line text input
- Selects - Dropdown selections
- Checkboxes - Boolean selections
- Switches - Toggle controls
- Labels - Form labels
- Badges - Status indicators
- Alerts - Important messages with variants
- Progress - Progress indicators
- Code Block - Syntax highlighted code with copy functionality
- Markdown - Rendered markdown with KaTeX math support
- Diff Viewer - Code difference viewer
- Theme Toggle - Dark/light mode switcher
- Language Selector - i18n language switcher
- icon() - Render Lucide icons with size variants
- i18n() - Internationalization support
Stateless components that return TemplateResult:
import { Button, Card, Badge } from "@mariozechner/mini-lit";
// Use directly in templates
${Button({ variant: "primary", children: "Click me" })}
${Badge({ children: "New" })}Stateful components that extend LitElement:
// Custom elements are automatically registered when using the main import
import "@mariozechner/mini-lit";
// Use as HTML tags
<theme-toggle></theme-toggle>
<code-block .code=${"console.log('Hello')"} language="javascript"></code-block>mini-lit uses shadcn/ui compatible themes with CSS custom properties for colors, borders, and shadows.
default- Clean, modern themeclaude- Claude-inspired theme
Switch themes by importing a different CSS file:
@import "@mariozechner/mini-lit/styles/themes/claude.css";Toggle dark mode via the dark class:
document.documentElement.classList.toggle("dark");Or use the built-in <theme-toggle> component.
For custom themes and theme generators:
declare module "@mariozechner/mini-lit" {
interface i18nMessages extends MiniLitRequiredMessages {
Welcome: string;
Settings: string;
cartItems: (count: number) => string;
greeting: (name: string, time: string) => string;
}
}import { setTranslations, defaultEnglish, defaultGerman } from "@mariozechner/mini-lit";
const translations = {
en: {
...defaultEnglish, // Includes required messages like "Copy", "Copied!"
Welcome: "Welcome",
Settings: "Settings",
cartItems: (count: number) =>
count === 0 ? "Your cart is empty" : count === 1 ? "1 item in your cart" : `${count} items in your cart`,
greeting: (name: string, time: string) => `Good ${time}, ${name}!`,
},
de: {
...defaultGerman, // Includes required messages like "Kopieren", "Kopiert!"
Welcome: "Willkommen",
Settings: "Einstellungen",
cartItems: (count: number) =>
count === 0
? "Ihr Warenkorb ist leer"
: count === 1
? "1 Artikel im Warenkorb"
: `${count} Artikel im Warenkorb`,
greeting: (name: string, time: string) => `Guten ${time}, ${name}!`,
},
};
setTranslations(translations);import { i18n, getCurrentLanguage, setLanguage } from "@mariozechner/mini-lit";
// Simple strings
${i18n("Welcome")}
${i18n("Settings")}
// Functions with parameters
${i18n("cartItems")(3)} // "3 items in your cart"
${i18n("greeting")("Alice", "morning")} // "Good morning, Alice!"
// Language management
getCurrentLanguage() // "en" or "de"
setLanguage("de") // switches to German, reloads page
// Add language selector to UI
<language-selector></language-selector>The mini-lit repository includes both the component library and a comprehensive example gallery showcasing all components.
# Clone the repository
git clone https://github.com/badlogic/mini-lit.git
cd mini-lit
# Install dependencies
npm installRun the development server with hot module replacement:
npm run devThis command orchestrates:
- TypeScript compilation of the mini-lit library (watching for changes in
/src, outputting to/dist) - Vite dev server for the example gallery (in
/example), automatically picking up the latest mini-lit builds
Open the URL displayed by Vite (typically http://localhost:5173) to view the example gallery. Any changes to either the mini-lit source code or the example application will trigger automatic rebuilds and browser updates through HMR.
mini-lit/
├── src/ # mini-lit component library source
├── dist/ # Compiled library output
├── styles/ # Theme CSS files
├── example/ # Interactive component gallery
│ └── src/
│ └── pages/ # Individual component demos
└── package.json # Library package configuration
Run formatting and linting checks for both the library and example:
npm run checkThis command:
- Formats all code with Prettier
- Lints with Biome for code quality and style consistency
- Type-checks both the library and example with TypeScript
- Automatically runs on git commit via Husky pre-commit hooks
# Build the library
npm run build
# Build the example gallery
cd example && npm run build# Build and publish the library to npm
npm run build
npm publish --access public# Quick sync (when only source files changed)
./run.sh sync
# Full deploy (when Docker/infrastructure changed)
./run.sh deployThe sync command builds and syncs files without restarting services, while deploy also restarts the Docker containers on the server.
See the /example directory for a complete working example with all components, or visit the live demo.
MIT