1 | <p align="center">
|
2 | <img src="https://cdn.rawgit.com/ElemeFE/element/dev/element_logo.svg">
|
3 | </p>
|
4 |
|
5 | <p align="center">
|
6 | <a href="https://travis-ci.org/ElemeFE/element">
|
7 | <img src="https://travis-ci.org/ElemeFE/element.svg?branch=master">
|
8 | </a>
|
9 | <a href="https://coveralls.io/github/ElemeFE/element?branch=master">
|
10 | <img src="https://coveralls.io/repos/github/ElemeFE/element/badge.svg?branch=master">
|
11 | </a>
|
12 | <a href="https://cdnjs.com/libraries/element-ui">
|
13 | <img src="https://img.shields.io/cdnjs/v/element-ui.svg">
|
14 | </a>
|
15 | <a href="https://www.npmjs.org/package/element-ui">
|
16 | <img src="https://img.shields.io/npm/v/element-ui.svg">
|
17 | </a>
|
18 | <a href="https://npmcharts.com/compare/element-ui?minimal=true">
|
19 | <img src="http://img.shields.io/npm/dm/element-ui.svg">
|
20 | </a>
|
21 | <br>
|
22 | <a href="http://img.badgesize.io/https://unpkg.com/element-ui/lib/index.js?compression=gzip&label=gzip%20size:%20JS">
|
23 | <img src="http://img.badgesize.io/https://unpkg.com/element-ui/lib/index.js?compression=gzip&label=gzip%20size:%20JS">
|
24 | </a>
|
25 | <a href="http://img.badgesize.io/https://unpkg.com/element-ui/lib/theme-chalk/index.css?compression=gzip&label=gzip%20size:%20CSS">
|
26 | <img src="http://img.badgesize.io/https://unpkg.com/element-ui/lib/theme-chalk/index.css?compression=gzip&label=gzip%20size:%20CSS">
|
27 | </a>
|
28 | <a href="#backers">
|
29 | <img src="https://opencollective.com/element/backers/badge.svg">
|
30 | </a>
|
31 | <a href="#sponsors">
|
32 | <img src="https://opencollective.com/element/sponsors/badge.svg">
|
33 | </a>
|
34 | <a href="LICENSE">
|
35 | <img src="https://img.shields.io/badge/License-MIT-yellow.svg">
|
36 | </a>
|
37 | </p>
|
38 |
|
39 | <p align="center">
|
40 | <b>Special thanks to the generous sponsorship by:</b>
|
41 | </p>
|
42 | <table>
|
43 | <tbody>
|
44 | <tr>
|
45 | <td align="center" valign="middle">
|
46 | <a href="https://tipe.io/?ref=element" target="_blank">
|
47 | <img width="150px" src="https://user-images.githubusercontent.com/1016365/34124854-48fafa06-e3e9-11e7-8c04-251055feebee.png">
|
48 | </a>
|
49 | </td>
|
50 | <td align="center" valign="middle">
|
51 | <a href="https://www.duotai.cn/?utm_source=element" target="_blank">
|
52 | <img width="140px" src="https://user-images.githubusercontent.com/10095631/39403151-c42dbcee-4ba5-11e8-9c09-8e5283da4144.png">
|
53 | </a>
|
54 | </td>
|
55 | <td align="center" valign="middle">
|
56 | <a href="https://www.duohui.cn/?utm_source=element&utm_medium=web&utm_campaign=element-index" target="_blank">
|
57 | <img width="150px" src="https://user-images.githubusercontent.com/10095631/35603534-bb24470c-0678-11e8-8bcc-17ceaef8cbef.png">
|
58 | </a>
|
59 | </td>
|
60 | <td align="center" valign="middle">
|
61 | <a href="https://bitsrc.io/" target="_blank">
|
62 | <img width="150px" src="https://user-images.githubusercontent.com/10095631/41342907-e44e7196-6f2f-11e8-92f2-47702dc8f059.png">
|
63 | </a>
|
64 | </td>
|
65 | </tr>
|
66 | </tbody>
|
67 | </table>
|
68 |
|
69 | > A Vue.js 2.0 UI Toolkit for Web.
|
70 |
|
71 | ## Links
|
72 | - Homepage and documentation
|
73 | - [International users](http://element.eleme.io/#/en-US)
|
74 | - [Chinese users](http://element-cn.eleme.io/#/zh-CN)
|
75 | - [Spanish users](http://element.eleme.io/#/es)
|
76 | - [awesome-element](https://github.com/ElementUI/awesome-element)
|
77 | - [FAQ](./FAQ.md)
|
78 | - [Customize theme](http://element.eleme.io/#/en-US/component/custom-theme)
|
79 | - [Preview and generate theme online](https://elementui.github.io/theme-chalk-preview)
|
80 | - [Element for React](https://github.com/elemefe/element-react)
|
81 | - [Element for Angular](https://github.com/ElemeFE/element-angular)
|
82 | - [Atom helper](https://github.com/ElemeFE/element-helper)
|
83 | - [Visual Studio Code helper](https://github.com/ElemeFE/vscode-element-helper)
|
84 | - Starter kit
|
85 | - [element-starter](https://github.com/ElementUI/element-starter)
|
86 | - [element-in-laravel-starter](https://github.com/ElementUI/element-in-laravel-starter)
|
87 | - [Design resources](https://github.com/ElementUI/Resources)
|
88 | - Gitter
|
89 | - [International users](https://gitter.im/element-en/Lobby)
|
90 | - [Chinese users](https://gitter.im/ElemeFE/element)
|
91 |
|
92 | ## Install
|
93 | ```shell
|
94 | npm install element-ui -S
|
95 | ```
|
96 |
|
97 | ## Quick Start
|
98 | ``` javascript
|
99 | import Vue from 'vue'
|
100 | import Element from 'element-ui'
|
101 |
|
102 | Vue.use(Element)
|
103 |
|
104 | // or
|
105 | import {
|
106 | Select,
|
107 | Button
|
108 | // ...
|
109 | } from 'element-ui'
|
110 |
|
111 | Vue.component(Select.name, Select)
|
112 | Vue.component(Button.name, Button)
|
113 | ```
|
114 | For more information, please refer to [Quick Start](http://element.eleme.io/#/en-US/component/quickstart) in our documentation.
|
115 |
|
116 | ## Browser Support
|
117 | Modern browsers and Internet Explorer 10+.
|
118 |
|
119 | ## Development
|
120 | Skip this part if you just want to use Element.
|
121 |
|
122 | For those who are interested in contributing to Element, please refer to our contributing guide ([中文](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.zh-CN.md) | [English](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.en-US.md) | [Español](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.es.md)) to see how to run this project.
|
123 |
|
124 | ## Changelog
|
125 | Detailed changes for each release are documented in the [release notes](https://github.com/ElemeFE/element/releases).
|
126 |
|
127 | ## FAQ
|
128 | We have collected some [frequently asked questions](https://github.com/ElemeFE/element/blob/master/FAQ.md). Before reporting an issue, please search if the FAQ has the answer to your problem.
|
129 |
|
130 | ## Contribution
|
131 | Please make sure to read the contributing guide ([中文](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.zh-CN.md) | [English](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.en-US.md) | [Español](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.es.md)) before making a pull request.
|
132 |
|
133 | ## Special Thanks
|
134 | English documentation is brought to you by SwiftGG Translation Team:
|
135 | - [raychenfj](https://github.com/raychenfj)
|
136 | - [kevin](http://thekevin.cn/)
|
137 | - [曾小涛](https://github.com/zengxiaotao)
|
138 | - [湾仔王二](https://github.com/wanzaiwanger)
|
139 | - [BlooDLine](http://www.ibloodline.com/)
|
140 | - [陈铭嘉](https://chenmingjia.github.io/)
|
141 | - [千叶知风](http://mpc6.com/)
|
142 | - [梁杰](http://numbbbbb.com)
|
143 | - [Changing](https://github.com/sunzhuo11)
|
144 | - [mmoaay](https://github.com/mmoaay)
|
145 |
|
146 | Spanish documentation is made possible by these community developers:
|
147 | - [adavie1](https://github.com/adavie1)
|
148 | - [carmencitaqiu](https://github.com/carmencitaqiu)
|
149 | - [coderdiaz](https://github.com/coderdiaz)
|
150 | - [fedegar33](https://github.com/fedegar33)
|
151 | - [Gonzalo2310](https://github.com/Gonzalo2310)
|
152 | - [lesterbx](https://github.com/lesterbx)
|
153 | - [ProgramerGuy](https://github.com/ProgramerGuy)
|
154 | - [SantiagoGdaR](https://github.com/SantiagoGdaR)
|
155 | - [sigfriedCub1990](https://github.com/sigfriedCub1990)
|
156 | - [thechosenjuan](https://github.com/thechosenjuan)
|
157 |
|
158 | ## Donation
|
159 | If you find Element useful, you can buy us a cup of coffee
|
160 |
|
161 | <img width="650" src="https://user-images.githubusercontent.com/14025786/44833997-5d7c4d80-ac62-11e8-8445-1dffec0eb13c.png" alt="donation">
|
162 |
|
163 | ## Backers
|
164 |
|
165 | Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/element#backer)]
|
166 |
|
167 | <a href="https://opencollective.com/element/backer/0/website" target="_blank"><img src="https://opencollective.com/element/backer/0/avatar.svg"></a>
|
168 | <a href="https://opencollective.com/element/backer/1/website" target="_blank"><img src="https://opencollective.com/element/backer/1/avatar.svg"></a>
|
169 | <a href="https://opencollective.com/element/backer/2/website" target="_blank"><img src="https://opencollective.com/element/backer/2/avatar.svg"></a>
|
170 | <a href="https://opencollective.com/element/backer/3/website" target="_blank"><img src="https://opencollective.com/element/backer/3/avatar.svg"></a>
|
171 | <a href="https://opencollective.com/element/backer/4/website" target="_blank"><img src="https://opencollective.com/element/backer/4/avatar.svg"></a>
|
172 | <a href="https://opencollective.com/element/backer/5/website" target="_blank"><img src="https://opencollective.com/element/backer/5/avatar.svg"></a>
|
173 | <a href="https://opencollective.com/element/backer/6/website" target="_blank"><img src="https://opencollective.com/element/backer/6/avatar.svg"></a>
|
174 | <a href="https://opencollective.com/element/backer/7/website" target="_blank"><img src="https://opencollective.com/element/backer/7/avatar.svg"></a>
|
175 | <a href="https://opencollective.com/element/backer/8/website" target="_blank"><img src="https://opencollective.com/element/backer/8/avatar.svg"></a>
|
176 | <a href="https://opencollective.com/element/backer/9/website" target="_blank"><img src="https://opencollective.com/element/backer/9/avatar.svg"></a>
|
177 | <a href="https://opencollective.com/element/backer/10/website" target="_blank"><img src="https://opencollective.com/element/backer/10/avatar.svg"></a>
|
178 | <a href="https://opencollective.com/element/backer/11/website" target="_blank"><img src="https://opencollective.com/element/backer/11/avatar.svg"></a>
|
179 | <a href="https://opencollective.com/element/backer/12/website" target="_blank"><img src="https://opencollective.com/element/backer/12/avatar.svg"></a>
|
180 | <a href="https://opencollective.com/element/backer/13/website" target="_blank"><img src="https://opencollective.com/element/backer/13/avatar.svg"></a>
|
181 | <a href="https://opencollective.com/element/backer/14/website" target="_blank"><img src="https://opencollective.com/element/backer/14/avatar.svg"></a>
|
182 | <a href="https://opencollective.com/element/backer/15/website" target="_blank"><img src="https://opencollective.com/element/backer/15/avatar.svg"></a>
|
183 | <a href="https://opencollective.com/element/backer/16/website" target="_blank"><img src="https://opencollective.com/element/backer/16/avatar.svg"></a>
|
184 | <a href="https://opencollective.com/element/backer/17/website" target="_blank"><img src="https://opencollective.com/element/backer/17/avatar.svg"></a>
|
185 | <a href="https://opencollective.com/element/backer/18/website" target="_blank"><img src="https://opencollective.com/element/backer/18/avatar.svg"></a>
|
186 | <a href="https://opencollective.com/element/backer/19/website" target="_blank"><img src="https://opencollective.com/element/backer/19/avatar.svg"></a>
|
187 | <a href="https://opencollective.com/element/backer/20/website" target="_blank"><img src="https://opencollective.com/element/backer/20/avatar.svg"></a>
|
188 | <a href="https://opencollective.com/element/backer/21/website" target="_blank"><img src="https://opencollective.com/element/backer/21/avatar.svg"></a>
|
189 | <a href="https://opencollective.com/element/backer/22/website" target="_blank"><img src="https://opencollective.com/element/backer/22/avatar.svg"></a>
|
190 | <a href="https://opencollective.com/element/backer/23/website" target="_blank"><img src="https://opencollective.com/element/backer/23/avatar.svg"></a>
|
191 | <a href="https://opencollective.com/element/backer/24/website" target="_blank"><img src="https://opencollective.com/element/backer/24/avatar.svg"></a>
|
192 | <a href="https://opencollective.com/element/backer/25/website" target="_blank"><img src="https://opencollective.com/element/backer/25/avatar.svg"></a>
|
193 | <a href="https://opencollective.com/element/backer/26/website" target="_blank"><img src="https://opencollective.com/element/backer/26/avatar.svg"></a>
|
194 | <a href="https://opencollective.com/element/backer/27/website" target="_blank"><img src="https://opencollective.com/element/backer/27/avatar.svg"></a>
|
195 | <a href="https://opencollective.com/element/backer/28/website" target="_blank"><img src="https://opencollective.com/element/backer/28/avatar.svg"></a>
|
196 | <a href="https://opencollective.com/element/backer/29/website" target="_blank"><img src="https://opencollective.com/element/backer/29/avatar.svg"></a>
|
197 |
|
198 |
|
199 | ## Sponsors
|
200 |
|
201 | Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/element#sponsor)]
|
202 |
|
203 | <a href="https://opencollective.com/element/sponsor/0/website" target="_blank"><img src="https://opencollective.com/element/sponsor/0/avatar.svg"></a>
|
204 | <a href="https://opencollective.com/element/sponsor/1/website" target="_blank"><img src="https://opencollective.com/element/sponsor/1/avatar.svg"></a>
|
205 | <a href="https://opencollective.com/element/sponsor/2/website" target="_blank"><img src="https://opencollective.com/element/sponsor/2/avatar.svg"></a>
|
206 | <a href="https://opencollective.com/element/sponsor/3/website" target="_blank"><img src="https://opencollective.com/element/sponsor/3/avatar.svg"></a>
|
207 | <a href="https://opencollective.com/element/sponsor/4/website" target="_blank"><img src="https://opencollective.com/element/sponsor/4/avatar.svg"></a>
|
208 | <a href="https://opencollective.com/element/sponsor/5/website" target="_blank"><img src="https://opencollective.com/element/sponsor/5/avatar.svg"></a>
|
209 | <a href="https://opencollective.com/element/sponsor/6/website" target="_blank"><img src="https://opencollective.com/element/sponsor/6/avatar.svg"></a>
|
210 | <a href="https://opencollective.com/element/sponsor/7/website" target="_blank"><img src="https://opencollective.com/element/sponsor/7/avatar.svg"></a>
|
211 | <a href="https://opencollective.com/element/sponsor/8/website" target="_blank"><img src="https://opencollective.com/element/sponsor/8/avatar.svg"></a>
|
212 | <a href="https://opencollective.com/element/sponsor/9/website" target="_blank"><img src="https://opencollective.com/element/sponsor/9/avatar.svg"></a>
|
213 | <a href="https://opencollective.com/element/sponsor/10/website" target="_blank"><img src="https://opencollective.com/element/sponsor/10/avatar.svg"></a>
|
214 | <a href="https://opencollective.com/element/sponsor/11/website" target="_blank"><img src="https://opencollective.com/element/sponsor/11/avatar.svg"></a>
|
215 | <a href="https://opencollective.com/element/sponsor/12/website" target="_blank"><img src="https://opencollective.com/element/sponsor/12/avatar.svg"></a>
|
216 | <a href="https://opencollective.com/element/sponsor/13/website" target="_blank"><img src="https://opencollective.com/element/sponsor/13/avatar.svg"></a>
|
217 | <a href="https://opencollective.com/element/sponsor/14/website" target="_blank"><img src="https://opencollective.com/element/sponsor/14/avatar.svg"></a>
|
218 | <a href="https://opencollective.com/element/sponsor/15/website" target="_blank"><img src="https://opencollective.com/element/sponsor/15/avatar.svg"></a>
|
219 | <a href="https://opencollective.com/element/sponsor/16/website" target="_blank"><img src="https://opencollective.com/element/sponsor/16/avatar.svg"></a>
|
220 | <a href="https://opencollective.com/element/sponsor/17/website" target="_blank"><img src="https://opencollective.com/element/sponsor/17/avatar.svg"></a>
|
221 | <a href="https://opencollective.com/element/sponsor/18/website" target="_blank"><img src="https://opencollective.com/element/sponsor/18/avatar.svg"></a>
|
222 | <a href="https://opencollective.com/element/sponsor/19/website" target="_blank"><img src="https://opencollective.com/element/sponsor/19/avatar.svg"></a>
|
223 | <a href="https://opencollective.com/element/sponsor/20/website" target="_blank"><img src="https://opencollective.com/element/sponsor/20/avatar.svg"></a>
|
224 | <a href="https://opencollective.com/element/sponsor/21/website" target="_blank"><img src="https://opencollective.com/element/sponsor/21/avatar.svg"></a>
|
225 | <a href="https://opencollective.com/element/sponsor/22/website" target="_blank"><img src="https://opencollective.com/element/sponsor/22/avatar.svg"></a>
|
226 | <a href="https://opencollective.com/element/sponsor/23/website" target="_blank"><img src="https://opencollective.com/element/sponsor/23/avatar.svg"></a>
|
227 | <a href="https://opencollective.com/element/sponsor/24/website" target="_blank"><img src="https://opencollective.com/element/sponsor/24/avatar.svg"></a>
|
228 | <a href="https://opencollective.com/element/sponsor/25/website" target="_blank"><img src="https://opencollective.com/element/sponsor/25/avatar.svg"></a>
|
229 | <a href="https://opencollective.com/element/sponsor/26/website" target="_blank"><img src="https://opencollective.com/element/sponsor/26/avatar.svg"></a>
|
230 | <a href="https://opencollective.com/element/sponsor/27/website" target="_blank"><img src="https://opencollective.com/element/sponsor/27/avatar.svg"></a>
|
231 | <a href="https://opencollective.com/element/sponsor/28/website" target="_blank"><img src="https://opencollective.com/element/sponsor/28/avatar.svg"></a>
|
232 | <a href="https://opencollective.com/element/sponsor/29/website" target="_blank"><img src="https://opencollective.com/element/sponsor/29/avatar.svg"></a>
|
233 |
|
234 |
|
235 |
|
236 | ## LICENSE
|
237 | [MIT](LICENSE)
|