Shadcn Nuxt

Shadcn Vue module for Nuxt.

• ✨  Release Notes

• 📖  Documentation

Features

• ⛰ Auto-import correct and relevant components
• more to come...

Quick Setup

1. Add shadcn-nuxt dependency to your project

1# Using pnpm
2pnpm add -D shadcn-nuxt
3
4# Using yarn
5yarn add --dev shadcn-nuxt
6
7# Using npm
8npm install --save-dev shadcn-nuxt

2. Add shadcn-nuxt to the modules section of nuxt.config.ts

1export default defineNuxtConfig({
2  modules: [
3    'shadcn-nuxt'
4  ],
5  shadcn: {
6    /**
7     * Prefix for all the imported component
8     */
9    prefix: '',
10    /**
11     * Directory that the component lives in.
12     * @default "./components/ui"
13     */
14    componentDir: './components/ui'
15  }
16})

That's it! You can now use Shadcn Nuxt in your Nuxt app ✨

Development

1# Install dependencies
2npm install
3
4# Generate type stubs
5npm run dev:prepare
6
7# Develop with the playground
8npm run dev
9
10# Build the playground
11npm run dev:build
12
13# Run ESLint
14npm run lint
15
16# Run Vitest
17npm run test
18npm run test:watch
19
20# Release new version
21npm run release