Skip to content
Showcase theme Default Brutalist Coral Inspired by Airbnb Midnight Inspired by Linear Editorial Inspired by Oura How theming works
Interface sounds: off

TanStack Start ​

Install and configure Luxen UI for TanStack Start.

Create project ​

Pick React. The scaffold comes with Tailwind CSS.

bash
npx @tanstack/cli@latest create my-app
bash
pnpm dlx @tanstack/cli@latest create my-app
bash
yarn dlx @tanstack/cli@latest create my-app
bash
bunx @tanstack/cli@latest create my-app

Install Luxen UI ​

bash
npm install luxen-ui
bash
pnpm add luxen-ui
bash
yarn add luxen-ui
bash
bun add luxen-ui

Configure the prefix ​

Create luxen.config.js at the project root. Uncomment to rename the l- prefix.

js
import { defineConfig } from 'luxen-ui';

export default defineConfig({
  // elementPrefix: 'my', // <my-badge>
  // cssPrefix: 'my', // .my-button, --my-color-*
});

Then load it in vite.config.ts:

ts
import { defineConfig } from 'vite'
import { devtools } from '@tanstack/devtools-vite'

import { tanstackStart } from '@tanstack/react-start/plugin/vite'

import viteReact from '@vitejs/plugin-react'
import tailwindcss from '@tailwindcss/vite'
import luxen from 'luxen-ui/vite-plugin'

const config = defineConfig({
  resolve: { tsconfigPaths: true },
  plugins: [devtools(), tailwindcss(), tanstackStart(), viteReact()], 
  plugins: [devtools(), tailwindcss(), luxen(), tanstackStart(), viteReact()], 
})

export default config

Import the CSS ​

css
@import 'tailwindcss';
/* ── Optional · Luxen tokens as Tailwind utilities ───────── */
@import 'luxen-ui/tailwind/preset';

/* ── Required ────────────────────────────────────────────── */
@import 'luxen-ui/css/preset';

/* ── Optional · native elements, CSS only ────────────────── */
/* @import 'luxen-ui/css/breadcrumb'; */
@import 'luxen-ui/css/button';
/* @import 'luxen-ui/css/checkbox'; */
/* @import 'luxen-ui/css/close-button/ring'; */ /* or /square, /circle */
/* @import 'luxen-ui/css/disclosure'; */
/* @import 'luxen-ui/css/input'; */
/* @import 'luxen-ui/css/kbd'; */
/* @import 'luxen-ui/css/progress'; */
/* @import 'luxen-ui/css/radio'; */
/* @import 'luxen-ui/css/radio-group'; */
/* @import 'luxen-ui/css/select'; */ /* native <select> */
/* @import 'luxen-ui/css/switch'; */
/* @import 'luxen-ui/css/table'; */
/* @import 'luxen-ui/css/textarea'; */

/* ── Optional · custom elements, add their JS too ────────── */
/* @import 'luxen-ui/css/alert'; */
@import 'luxen-ui/css/badge';
/* @import 'luxen-ui/css/button-group'; */
/* @import 'luxen-ui/css/divider'; */
/* @import 'luxen-ui/css/form-field'; */
/* @import 'luxen-ui/css/input-otp'; */
/* @import 'luxen-ui/css/input-stepper/default'; */ /* or /rounded, /pill */
/* @import 'luxen-ui/css/prose-editor'; */
/* @import 'luxen-ui/css/segmented-control'; */
/* @import 'luxen-ui/css/skeleton'; */
/* @import 'luxen-ui/css/stories'; */
/* @import 'luxen-ui/css/story'; */
/* @import 'luxen-ui/css/tabs/line'; */ /* or /enclosed */
/* @import 'luxen-ui/css/toast'; */

Import the elements ​

ts
// ── Optional · custom elements, add their CSS too ────────────
// import 'luxen-ui/alert';
import 'luxen-ui/badge';
// import 'luxen-ui/button-group';
// import 'luxen-ui/divider';
// import 'luxen-ui/form-field';
// import 'luxen-ui/input-otp';
// import 'luxen-ui/input-stepper';
// import 'luxen-ui/prose-editor';
// import 'luxen-ui/segmented-control';
// import 'luxen-ui/skeleton';
// import 'luxen-ui/stories';
// import 'luxen-ui/story';
// import 'luxen-ui/tabs';
// import 'luxen-ui/toast';

// ── Optional · custom elements, JS only ──────────────────────
// import 'luxen-ui/alert-dialog';
// import 'luxen-ui/avatar';
// import 'luxen-ui/carousel';
// import 'luxen-ui/carousel-item';
// import 'luxen-ui/color-scheme-icon';
// import 'luxen-ui/combobox';
// import 'luxen-ui/dialog';
// import 'luxen-ui/drawer';
// import 'luxen-ui/dropdown';
// import 'luxen-ui/dropdown-item';
// import 'luxen-ui/dropdown-label';
// import 'luxen-ui/icon';
// import 'luxen-ui/input-group';
// import 'luxen-ui/popover';
// import 'luxen-ui/rating';
// import 'luxen-ui/select';
// import 'luxen-ui/slider';
// import 'luxen-ui/spinner';
// import 'luxen-ui/sticky-bar';
// import 'luxen-ui/stories-viewer';
// import 'luxen-ui/tag';
// import 'luxen-ui/tooltip';
// import 'luxen-ui/tree';
// import 'luxen-ui/tree-item';

Then import it once in the root route:

tsx
import { HeadContent, Scripts, createRootRoute } from '@tanstack/react-router';
import '../luxen'; 

Type the custom elements ​

Create src/custom-elements.d.ts so TypeScript accepts <l-*> tags in JSX:

ts
import type { HTMLAttributes } from 'react';

declare module 'react' {
  namespace JSX {
    interface IntrinsicElements {
      // match elementPrefix
      [tag: `l-${string}`]: HTMLAttributes<HTMLElement> & Record<string, unknown>;
    }
  }
}

Use the elements ​

tsx
import { createFileRoute } from '@tanstack/react-router';

export const Route = createFileRoute('/')({ component: Home });

function Home() {
  return (
    <div className="p-8">
      <h1 className="text-4xl font-bold">Welcome to TanStack Start</h1>
      <p className="mt-4 text-lg">Edit <code>src/routes/index.tsx</code> to get started.</p>
      <button className="l-button" data-variant="primary">Save</button>
      <l-badge>New</l-badge>
    </div>
  );
}