Docs
Nuxt

Nuxt

Install and configure Nuxt.

Create project ​

Start by creating a new Nuxt project using create-next-app:

bash
npx nuxi@latest init my-app

Install TailwindCSS module ​

bash
npm install -D @nuxtjs/tailwindcss

Configure nuxt.config.ts ​

ts
export default defineNuxtConfig({
  modules: ['@nuxtjs/tailwindcss'],
  components: [
    {
      path: '~/components/ui',
      // this is required else Nuxt will autoImport `.ts` file
      extensions: ['.vue'],
      // prefix for your components, eg: UiButton
      prefix: 'Ui'
    },
  ],
})

Run the CLI ​

Run the shadcn-vue init command to setup your project:

bash
npx shadcn-vue@latest init

Configure components.json ​

You will be asked a few questions to configure components.json:

txt
Would you like to use TypeScript (recommended)? no / yes
Which framework are you using? Vite / Nuxt / Laravel
Which style would you like to use? › Default
Which color would you like to use as base color? › Slate
Where is your global CSS file? › › src/index.css
Do you want to use CSS variables for colors? › no / yes
Where is your tailwind.config.js located? › tailwind.config.js
Configure the import alias for components: › @/components
Configure the import alias for utils: › @/lib/utils

App structure ​

Here's the default structure of Nuxt app. You can use this as a reference:

txt
. 
├── pages
│   ├── index.vue
│   └── dashboard.vue
├── components
│   ├── ui
│   │   ├── alert-dialog
│   │   │   ├── AlertDialog.vue
│   │   │   └── ...
│   │   ├── button
│   │   │   ├── Button.vue
│   │   │   └── ...
│   │   ├── dropdown-menu
│   │   │   ├── Dropdown.vue
│   │   │   └── ...
│   │   └── ...
│   ├── MainNav.vue
│   ├── PageHeader.vue
│   └── ...
├── lib
│   └── utils.ts
├── assets
│   ├── css
│   │   └── tailwind.css
├── app.vue
├── nuxt.config.ts
├── package.json
├── tailwind.config.js
└── tsconfig.json
  • I place the UI components in the components/ui folder.
  • The rest of the components such as <PageHeader /> and <MainNav /> are placed in the components folder.
  • The lib folder contains all the utility functions. I have a utils.ts where I define the cn helper.
  • The assets/css folder contains the global CSS.

That's it ​

You can now start adding components to your project.

bash
npx shadcn-vue@latest add button

The command above will add the Button component to your project. Nuxt autoImport will handle importing the components, you can just use it as such:

vue
<template>
  <div>
    <UiButton>Click me</UiButton>
  </div>
</template>
Edit this page on GitHub