#Get started with Vuetify 3

#Installation

To get started with Vuetify 3, simply paste the following code into your terminal:

yarn create vuetify

This command prompts you with a few options before generating your scaffolded Vue / Vuetify 3 project.

success Installed "create-vuetify@x.x.x" with binaries:
    - create-vuetify

? Project name: ❯ vuetify-project // the folder to generate your application
? Use TypeScript?: ❯ No / Yes
? Would you like to install dependencies with yarn, npm, or pnpm?:
  ❯ yarn
    npm
    pnpm
    none

After making your selections, create-vuetifywill generate the structure for your new application.

Once the scaffold is complete, start the vite development server by running the following commands:

cd vuetify-project
yarn dev

For more information regarding supported package managers, please visit their official websites:

• yarn
• npm
• pnpm

import '@mdi/font/css/materialdesignicons.css'
import 'vuetify/styles'

const vuetify = createVuetify({
  ssr: true,
})

#Vue CLI

Vue CLI is currently in maintenance mode and no longer the default tooling used to build Vue applications. Vuetify projects are now generated using vite. We plan on enabling the Vue CLI installation path in an official guide in the future.

#Manual steps

Follow these steps if for example you are adding Vuetify to an existing project, or simply do not want to use a scaffolding tool.

yarn add vuetify@^3.3.3

In the file where you create the Vue application, add the following code

import { createApp } from 'vue'
import App from './App.vue'

// Vuetify
import 'vuetify/styles'
import { createVuetify } from 'vuetify'
import * as components from 'vuetify/components'
import * as directives from 'vuetify/directives'

const vuetify = createVuetify({
  components,
  directives,
})

createApp(App).use(vuetify).mount('#app')

This will include all components and directives regardless of whether or not you are using them. If you instead only want to include used components, have a look at the Viteor Webpackplugins, depending on your setup. The plugins also makes it possible to customize SCSS variables.

Lastly, do not forget to install icons.

#CDN

We recommend using the latest version of Vuetify 3 from jsdelivr. All components and styles are included.

https://cdn.jsdelivr.net/npm/vuetify@3.3.3/dist/vuetify.min.css

https://cdn.jsdelivr.net/npm/vuetify@3.3.3/dist/vuetify.min.js

const { createApp } = Vue
const { createVuetify } = Vuetify

const vuetify = createVuetify()

const app = createApp()
app.use(vuetify).mount('#app')

#Using Laravel Mix

import { createApp } from 'vue'
import App from './App.vue'

// Vuetify
import '@mdi/font/css/materialdesignicons.css'
import 'vuetify/styles'
import { createVuetify } from 'vuetify'
import * as components from 'vuetify/components'
import * as directives from 'vuetify/directives'

const vuetify = createVuetify({
  components,
  directives
})

createApp(App).use(vuetify).mount('#app')

To import the fonts you need to add to webpack.mix.js:

mix.copy('node_modules/@mdi/font/fonts/', 'dist/fonts/')

#Exposed exports

#Nightly Builds

The three development branches (master, dev, and next) are automatically published to NPM at 1200 UTC under the @vuetify/nightlynamespace. They may be outdated or buggy and are therefore not officially supported and are only supplied for testing purposes. These builds can be installed with a package alias.

 "devDependencies": {
-  "vuetify": "^3.3.0"
+  "vuetify": "npm:@vuetify/nightly@3.3.0-master.2023-05-21"
 }

#Questions

Have a question that belongs here? Tell us in our Discord Communityor create a request on our Issue Generator.