JavaScripting

The definitive source of the best
JavaScript libraries, frameworks, and plugins.


  • ×

    πŸ‰ Material Component Framework for Vue.js 2
    Filed under  β€Ί 

    • 🔾95%Overall
    • 21,566
    • 5 hours
    • 🕩2755
    • 👥23

    travis ci badge Coverage Downloads Downloads
    License zenhub Chat
    Version Next version CDN


    Supporting Vuetify

    Vuetify is an open source MIT project that has been made possible due to the generous contributions by community backers. If you are interested in supporting this project, please consider:


    Sponsors

    $1500/mo

    $500/mo

    $250/mo



    Open Collective Sponsors


    Introduction

    Vuetify is a semantic component framework for Vue. It aims to provide clean, semantic and reusable components that make building your application a breeze.

    Build amazing applications with the power of Vue, Material Design and a massive library of beautifully crafted components and features. Built according to Google's Material Design Spec, Vuetify components feature an easy-to-remember semantic design that shifts remembering complex classes and markup, to type-as-you speak properties that have simple and clear names.

    Harness the power of the Vuetify community and get help 24/7 from the development team and our talented community members across the world. Become a backer and get access to dedicated support from the team.

    Browser Support

    Vuetify supports all modern browsers, including IE11 and Safari 9+ (using polyfills). From mobileπŸ“± to laptop πŸ’» to desktop πŸ–₯, you can rest assured that your application will work as expected.

    Interested in the bleeding edge? Try the Vue CLI 3 Webpack SSR (Server side rendered) template and build websites optimized for SEO.

    For more information about IE11 and Safari 9+ polyfills, visit our Quick Start Guide

    Documentation

    To view our docs πŸ“‘, get support 🀯 and the store πŸ›’ visit us at vuetifyjs.com.

    Getting Started

    To get started with Vuetify, you can follow one of these simple set-up instructions.

    One Click Quick-start

    Looking to dive right in with zero setup and downtime? Check out our CodePen.io One Minute Quickstart

    Vue CLI 3 Installation

    Setting up Vuetify with Vue's CLI is really easy πŸ‘Œ.

    (Unsure of how to install Vue's CLI on your system? Check out the official Installation Instructions or our Quick Start Guide)

    If you're setting up a new project, first create it using the CLI's create command.

    vue create my-app
    

    If you are adding Vuetify to an existing Vue CLI 3 project, navigate to your project's root inside your terminal.

    cd /path/to/project
    

    Now, add Vuetify as a plugin with the CLI's add utility.

    vue add vuetify
    

    Note that you can also find and install Vuetify through Vue's UI!

    Navigate to your project folder, or create a new Vue CLI app, then run the following command.

    vue ui
    

    Once the UI launches in your browser, click the + Add plugin button on the top right corner of your screen. On the next screen, search for Vuetify on the list, select it, and install it using the Install vue-cli-plugin-vuetify button on the bottom right.

    Vue CLI 3 Ecosystem 🌎

    Project Version Description
    vue-cli-plugin-vuetify Version A Vue CLI 3 plugin for installing and configuring Vuetify
    vuetify-loader Version A webpack plugin for treeshaking and progressive image support
    eslint-config-vuetify Version An opinionated eslint-config for Vuetify
    vuex-cognito-module Version A Vuex module for AWS Cognito

    Manual Installation Through Package Managers

    Looking to add Vuetify to your project directly as a node module? You can easily accomplish this by using yarn or npm package managers πŸ“¦.

    yarn add vuetify
    # OR
    npm install vuetify
    

    Once you have the library installed, we need to hook it up to Vue.

    Fire up your favorite IDE, and head to the file in which you are importing Vue to your project and creating your application.

    import Vue from 'vue'
    import Vuetify from 'vuetify' // Import Vuetify to your project
    
    Vue.use(Vuetify) // Add Vuetify as a plugin
    

    For including styles 🎨, you can either place the below styles in your index.html (if using the CLI) or directly at your app's entry point.

    <link href="https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900" rel="stylesheet">
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@mdi/font@latest/css/materialdesignicons.min.css">
    <link href="https://cdn.jsdelivr.net/npm/vuetify@2.x/dist/vuetify.min.css" rel="stylesheet">
    

    Or you can import it to your webpack entry point file. This is usually your main.js file.

    import 'https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900'
    import '@mdi/font/css/materialdesignicons.css'
    import 'vuetify/dist/vuetify.min.css'
    

    Don't forget to install Material Design Icons as a dependency:

    yarn add @mdi/font -D
    # OR
    npm install @mdi/font -D
    

    For more information, please visit the quick-start guide.

    Manual Installation Through CDN

    To use Vuetify in your project by directly importing it through CDNs (Content Delivery Networks), add the following code to the <head> of your HTML document.

    <link href="https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900" rel="stylesheet">
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@mdi/font@latest/css/materialdesignicons.min.css">
    <link href="https://cdn.jsdelivr.net/npm/vuetify@2.x/dist/vuetify.min.css" rel="stylesheet">
    

    Don't forget to add both Vuetify and the main Vue library to your HTML file before the closing </body> tag.

    <script src="https://cdn.jsdelivr.net/npm/vue@2.x/dist/vue.js"></script>
    <script src="https://cdn.jsdelivr.net/npm/vuetify@2.x/dist/vuetify.js"></script>
    

    Community Support

    Ask your support questions on the Vuetify Discord Community πŸ’¬.

    Frequently asked questions and Gotchas on the FAQ Guide ❓

    Contributing

    Developers interested in contributing should read the Code of Conduct πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’» and the Contribution Guide.

    Please do not ask general questions in an issue. Issues are only to report bugs, suggest enhancements, or request new features. For general questions and discussions, ask in the Vuetify Discord Community.

    It is important to note that for each release, the detailed changes are documented in the release notes.

    Reporting Guide

    You can report issues by following the Issue Template and providing a minimal reproduction with a CodePen template or a full project at CodeSandbox.

    Good First Issue

    To help you get you familiar with our contribution process, we have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started.

    We also have a list of help wanted issues that you might want to check.

    Credits

    Contributors

    This project exists thanks to all the people who contribute 😍!

    Backers

    Thank you to all our backers! πŸ™ [Become a backer]

    Sponsors

    Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

    License

    Vuetify is MIT licensed.

    Show All