Skip to content

Latest commit

 

History

History
139 lines (102 loc) · 5.33 KB

README.md

File metadata and controls

139 lines (102 loc) · 5.33 KB
Raw

Material Design for Vue.js

Downloads Version License

DEPRECATED: This is a deprecated version of Vue Material. Please follow the current version of the project.

Vue Material is lightweight framework built exactly according to the Material Design specs.

It aims to deliver a collection of reusable components and a series of UI Elements to build applications with support to all modern Web Browsers through Vue 2.

Build powerful and well-designed web apps that can fit on every screen. You can generate and use themes dynamically, use components on demand, take advantage of UI Elements and Components with an ease-to-use API.

Demo and Documentation

Demo

Installation

Import Roboto and Material Icons from Google CDN:

<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Roboto:300,400,500,700,400italic">
<link rel="stylesheet" href="//fonts.googleapis.com/icon?family=Material+Icons">

Install Vue Material through npm or yarn

npm install --save [email protected]
yarn add [email protected]

* Others package managers like JSPM and Bower are not supported yet.

Import or require Vue and Vue Material in your code:

import Vue from 'vue'
import VueMaterial from 'vue-material'
import 'vue-material/dist/vue-material.css'

// OR

var Vue = require('vue')
var VueMaterial = require('vue-material')
require('vue-material/dist/vue-material.css')

Alternativelly you can download and reference the script and the stylesheet in your HTML:

<link rel="stylesheet" href="path/to/vue-material.css">
<script src="path/to/vue-material.js"></script>

Usage

Enable Vue Material in your application using Vue.use(). You can always enable individual components:

Vue.use(VueMaterial)

// OR

Vue.use(VueMaterial.MdCore) //Required to boot vue material
Vue.use(VueMaterial.MdButton)
Vue.use(VueMaterial.MdIcon)
Vue.use(VueMaterial.MdSidenav)
Vue.use(VueMaterial.MdToolbar)

Sponsors & Backers

Vue Material do not run under the umbrella of any company or something like that. Is an independent project created by Marcos Moura on spare time that became one of the most used UI Libraries for Vue.js. The development is active and we are working hard to release great things for you.

If you think that this project helped you or your company in some way, you can consider become a backer/sponsor on Patreon:

Sponsors

Yatima Kagurazaka

Changelog

Changelog

Questions

The issue list is exclusively for reports, bugs and feature requests. Use the Slack instead.

Contributing

Please make sure to read the Contributing Guide before making a pull request.

Browser Support

Vue Material supports the latest version of all Browsers. This means:

  • Google Chrome 52+
  • Firefox 48+
  • Safari 9+
  • Opera 38+
  • Edge 12+
  • IE 11

May work in other browsers but it's untested.

Credits and Thanks

  • This library aims to delivery components using almost the same API of Angular Material
  • Thanks a lot to elviskang for donating the npm package name!
  • Thanks to Evan You for allowing me to use Vue.js Logo.

Internal Dependencies

You don't need to include any other library to work with vue-material. The focus of this project is to have a standalone build with no external dependence, but aiming to deliver the best experience without break the compatibility with the Vue.js core.

License

MIT