jangocheng / vue-material Goto Github PK

Material Design for Vue.js

Vue Material is Simple, lightweight and built exactly according to the Google Material Design specs

Build well-designed apps that can fit on every screen with support to all modern Web Browsers with dynamic themes, components on demand and all with an ease-to-use API

Sponsorship

Vue Material is proudly sponsored by Rollbar. They provide real-time JavaScript error monitoring, alerting, and analytics for developers. 🚀

You can try Rollbar for free at https://rollbar.com

Demo and Documentation

Documentation & demos

Examples

If you are trying to find the documentation for previous versions, please go to old website.

Installation and Usage

Install Vue Material through npm or yarn

npm install vue-material --save
yarn add vue-material

* 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.min.css'

Vue.use(VueMaterial)

Or use individual components:

import Vue from 'vue'
import { MdButton, MdContent, MdTabs } from 'vue-material/dist/components'
import 'vue-material/dist/vue-material.min.css'

Vue.use(MdButton)
Vue.use(MdContent)
Vue.use(MdTabs)

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>

Optionally import Roboto font & Material Icons from Google CDN:

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

Changelog

Changelog

Questions

If you have any questions, ideas or you want to discuss with Vue Material community. Use the Discord

Or you can use Slack Channel. Follow this invitation link for Slack.

Contributing

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

Browser Support

Vue Material supports all modern browsers.

May work in other browsers but it's untested.

Credits and Thanks

• elviskang for donating the npm package name!
• Bruno Castro for the awesome Vue Material Logo.

License

MIT