Home

Awesome

<div align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/vuetifyjs/nuxt-module/raw/main/hero-dark.svg" /> <img alt="vuetify-nuxt-module - Zero-config Nuxt Module for Vuetify" src='https://github.com/vuetifyjs/nuxt-module/raw/main/hero.svg' alt="vuetify-nuxt-module - Zero-config Nuxt Module for Vuetify"><br> </picture> <p>Zero-config Nuxt Module for Vuetify</p> </div> <p align='center'> <a href='https://www.npmjs.com/package/vuetify-nuxt-module' target="__blank"> <img src='https://img.shields.io/npm/v/vuetify-nuxt-module?color=33A6B8&label=' alt="NPM version"> </a> <a href="https://www.npmjs.com/package/vuetify-nuxt-module" target="__blank"> <img alt="NPM Downloads" src="https://img.shields.io/npm/dm/vuetify-nuxt-module?color=476582&label="> </a> <a href="https://nuxt.vuetifyjs.com/" target="__blank"> <img src="https://img.shields.io/static/v1?label=&message=docs%20%26%20guides&color=2e859c" alt="Docs & Guides"> </a> <br> <a href="https://github.com/vuetifyjs/nuxt-module" target="__blank"> <img alt="GitHub stars" src="https://img.shields.io/github/stars/userquin/vuetify-nuxt-module?style=social"> </a> </p> <br>

πŸš€ Features

πŸ“¦ Install

Requires Vite, will not work with Webpack

npx nuxi@latest module add vuetify-nuxt-module

Open in StackBlitz

πŸ¦„ Usage

vuetify-nuxt-module is strongly opinionated and has a built-in default configuration out of the box. You can use it without any configuration, and it will work for most use cases.

Add vuetify-nuxt-module module to nuxt.config.ts and configure it:

// Nuxt config file
import { defineNuxtConfig } from 'nuxt/config'

export default defineNuxtConfig({
  modules: [
    'vuetify-nuxt-module'
  ],
  vuetify: {
    moduleOptions: {
      /* module specific options */
    },
    vuetifyOptions: {
      /* vuetify options */
    }
  }
})

Read the πŸ“– documentation for a complete guide on how to configure and use this module.

πŸ‘€ Full config

Check out the types.

The virtual modules can be found in configuration.d.ts file.

πŸ“„ License

MIT License Β© 2023-PRESENT JoaquΓ­n SΓ‘nchez