1.0.3 • Published 1 year ago

@jacobgardos/vuxtify v1.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Vuxtify

npm version npm downloads License Nuxt

A Nuxt Module for Vuetify 3

Features

  • 📦  Tree Shaking
  • 🚀  Vite Builder Compatible
  • ⚙️  Webpack Builder Compatible
  • 💅  Easily Customize Sass Variables
  • 📚  Auto Imported Vuetify Composables
  • 🧩  Provide $vuetify
  • 🤖  Automatically Suggests Dependencies
  • 🎨  HMR Theme Altering

Quick Setup

  1. Add @jacobgardos/vuxtify dependency to your project
# Using pnpm
pnpm add -D @jacobgardos/vuxtify

# Using yarn
yarn add --dev @jacobgardos/vuxtify

# Using npm
npm install --save-dev @jacobgardos/vuxtify
  1. Add vuxtify to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: ["@jacobgardos/vuxtify"],
  vuxtify: {
    // ... Module Options See Docs
  },
});
  1. Add your vuetify options to your app.config.ts file
export default defineAppConfig({
  vuetify: {
    theme: {
      defaultTheme: "light",
      themes: {
        light: {
          colors: {
            primary: "#1976D2",
            secondary: "#424242",
            accent: "#82B1FF",
            error: "#FF5252",
            info: "#2196F3",
            success: "#4CAF50",
            warning: "#FFC107",
          },
        },
      },
    },
  },
});

That's it! You can now use Vuetify in your Nuxt app ✨ Check out the docs for more details and examples.

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release