Skip to content

Latest commit

 

History

History
140 lines (115 loc) · 6.48 KB

README.md

File metadata and controls

140 lines (115 loc) · 6.48 KB
Raw

Material Components for Vue

vue-mdc-adapter is an integration of Material Components for Vue.js which follows the best practices recommended by Google: Using Foundations and Adapters

This project aims to find the right balance between ease of use and customization while sticking to the Vue Spirit (approachable, versatile, and performant)

Quick Links

Project Status

This project is under active development. The focus is on known issues, validation, and keeping up with MDC updates.
Do not hesitate to open an issue on GitHub, contact us on Gitter, or follow us on Twitter @vuemdc

Each MDCWeb component is mapped to a single vue plugin

Extra plugins

  • layout-app: provides a flexible layout to simplify toolbar vs drawer positioning
  • icon: provides a material icon wrapper with support for font-awesome, svg, etc.

Quick Start

Playground

Fork the reference codepen template or one of the vue-mdc-adapter codepen collection or the CodeSandbox

CDN

<head>
  <!-- import reset material icons, fonts and vue-mdc-adapter stylesheets -->
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/7.0.0/normalize.min.css">
  <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500" type="text/css">

  <!-- import vue and then vue-mdc-adapter -->
  <script src="https://unpkg.com/vue"></script>
  <script src="https://unpkg.com/vue-mdc-adapter"></script>
</head>
<body>
  <!-- vue mdc markup -->
<body>

Vue CLI

Simple
npm install -g vue-cli
vue init stasson/vue-mdc-adapter-simple my-project
Webpack
npm install -g vue-cli
vue init stasson/vue-mdc-adapter-webpack my-project
cd my-project
npm install
npm run dev

Check out the Getting Started guide for more.