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

Nuxt ​

Install and configure Luxen UI for Nuxt.

Create project ​

bash
npm create nuxt@latest my-app
bash
pnpm create nuxt@latest my-app
bash
yarn create nuxt@latest my-app
bash
bun create nuxt@latest 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-*
});

Configure Nuxt ​

ts
import luxen from 'luxen-ui/vite-plugin'; 

export default defineNuxtConfig({
  compatibilityDate: '2025-07-15',
  devtools: { enabled: true },
  css: ['~/assets/css/main.css'],
  vue: {
    compilerOptions: {
      isCustomElement: (tag) => tag.startsWith('l-'), // match elementPrefix
    },
  },
  vite: { plugins: [luxen()] },
});

Import the CSS ​

css
/* ── 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';

export default defineNuxtPlugin(() => {});

Use the elements ​

vue
<template>
  <div>
    <NuxtRouteAnnouncer />
    <NuxtWelcome /> 
    <button class="l-button" data-variant="primary">Save</button> 
    <l-badge>New</l-badge> 
  </div>
</template>