You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+59-7Lines changed: 59 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,64 @@
4
4
5
5
Vue Material is lightweight framework built exactly according to the <ahref="http://material.google.com"target="_blank">Material Design</a> specs. It aims to deliver a collection of reusable components and a series of UI Elements to build applications with support to <ahref="https://saucelabs.com/u/vuejs"target="_blank">modern Web Browsers</a> through Vue 2.0. Build powerful and well-designed web apps that can 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.
6
6
7
+
## Installation
8
+
9
+
Install Vue Material through npm or yarn
10
+
```bash
11
+
npm install --save vue-material
12
+
yarn add vue-material
13
+
```
14
+
15
+
Or <ahref="https://github.com/marcosmoura/vue-material/archive/master.zip"target="_blank"rel="noopener">download</a> and reference the script and the stylesheet in your HTML:
Enable Vue Material in your application using ```Vue.use()```. You can always enable individual components:
23
+
```javascript
24
+
Vue.use(VueMaterial);
25
+
26
+
// OR
27
+
28
+
Vue.use(VueMaterial.MdCore); //Required to boot vue material
29
+
Vue.use(VueMaterial.MdButton);
30
+
Vue.use(VueMaterial.MdIcon);
31
+
Vue.use(VueMaterial.MdSidenav);
32
+
Vue.use(VueMaterial.MdToolbar);
33
+
```
34
+
35
+
To get Vue Material working properly, you'll need to configure and apply a default theme.
36
+
37
+
```javascript
38
+
Vue.material.theme.register('default', {
39
+
primary:'cyan',
40
+
accent:'pink'
41
+
});
42
+
```
43
+
44
+
Or you can register multiple themes at once.
45
+
46
+
```javascript
47
+
Vue.material.theme.registerAll({
48
+
default: {
49
+
primary:'cyan',
50
+
accent:'pink'
51
+
},
52
+
phone: {
53
+
primary:'indigo',
54
+
accent:'pink'
55
+
}
56
+
});
57
+
```
58
+
7
59
## Build Setup
8
60
9
61
```bash
10
62
### Install dependencies
11
-
npm install or yarn
63
+
npm install
64
+
yarn
12
65
13
66
### Start dev server with hot reload
14
67
npm run dev
@@ -24,13 +77,12 @@ npm run build:lib
24
77
```
25
78
26
79
## Credits and Thanks
27
-
This library aims to delivery components using almost the same API of <ahref="https://material.angularjs.org/latest/"target="_blank">Angular Material</a>
28
-
29
-
Thanks a lot to <ahref="https://github.com/elviskang"target="_blank">elviskang</a> who provided me the **vue-material** name on npm.
30
-
31
-
Thanks to <ahref="https://github.com/yyx990803"target="_blank">Evan You</a> for allowing me to use Vue.js Logo.
80
+
* This library aims to delivery components using almost the same API of <ahref="https://material.angularjs.org/latest/"target="_blank">Angular Material</a>
81
+
* Thanks a lot to <ahref="https://github.com/elviskang"target="_blank">elviskang</a> who provided me the **vue-material** name on npm.
82
+
* Thanks to <ahref="https://github.com/yyx990803"target="_blank">Evan You</a> for allowing me to use Vue.js Logo.
32
83
33
-
## Dependencies
84
+
## Internal Dependencies
85
+
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.
0 commit comments