2016-12-13 20:52:52 +08:00
< p align = "center" >
2016-12-13 22:14:11 +08:00
< img src = "https://cdn.rawgit.com/ElemeFE/element/dev/element_logo.svg" >
2016-12-13 20:52:52 +08:00
< / p >
2017-03-20 14:47:23 +08:00
2018-03-15 10:48:11 +08:00
< p align = "center" >
< a href = "https://travis-ci.org/ElemeFE/element" >
< img src = "https://travis-ci.org/ElemeFE/element.svg?branch=master" >
< / a >
< a href = "https://coveralls.io/github/ElemeFE/element?branch=master" >
< img src = "https://coveralls.io/repos/github/ElemeFE/element/badge.svg?branch=master" >
< / a >
< a href = "https://cdnjs.com/libraries/element-ui" >
< img src = "https://img.shields.io/cdnjs/v/element-ui.svg" >
< / a >
< a href = "https://www.npmjs.org/package/element-ui" >
< img src = "https://img.shields.io/npm/v/element-ui.svg" >
< / a >
< a href = "https://npmcharts.com/compare/element-ui?minimal=true" >
< img src = "http://img.shields.io/npm/dm/element-ui.svg" >
< / a >
< br >
< a href = "http://img.badgesize.io/https://unpkg.com/element-ui/lib/index.js?compression=gzip&label=gzip%20size:%20JS" >
< img src = "http://img.badgesize.io/https://unpkg.com/element-ui/lib/index.js?compression=gzip&label=gzip%20size:%20JS" >
< / a >
< a href = "http://img.badgesize.io/https://unpkg.com/element-ui/lib/theme-chalk/index.css?compression=gzip&label=gzip%20size:%20CSS" >
< img src = "http://img.badgesize.io/https://unpkg.com/element-ui/lib/theme-chalk/index.css?compression=gzip&label=gzip%20size:%20CSS" >
< / a >
< a href = "#backers" >
< img src = "https://opencollective.com/element/backers/badge.svg" >
< / a >
< a href = "#sponsors" >
< img src = "https://opencollective.com/element/sponsors/badge.svg" >
< / a >
< a href = "LICENSE" >
< img src = "https://img.shields.io/badge/License-MIT-yellow.svg" >
< / a >
< / p >
2017-03-20 14:47:23 +08:00
2020-10-29 10:10:12 +08:00
> A Vue.js 2.0 UI Toolkit for Web.
Element will stay with Vue 2.x
For Vue 3.0, we recommend using [Element Plus ](https://github.com/element-plus/element-plus ) from the same team
2017-12-18 17:38:51 +08:00
< p align = "center" >
< b > Special thanks to the generous sponsorship by:< / b >
< / p >
2018-01-31 11:22:05 +08:00
< table >
< tbody >
< tr >
< td align = "center" valign = "middle" >
< a href = "https://tipe.io/?ref=element" target = "_blank" >
< img width = "150px" src = "https://user-images.githubusercontent.com/1016365/34124854-48fafa06-e3e9-11e7-8c04-251055feebee.png" >
< / a >
2018-04-29 12:09:35 +08:00
< / td >
2018-01-31 11:22:05 +08:00
< td align = "center" valign = "middle" >
< a href = "https://www.duohui.cn/?utm_source=element&utm_medium=web&utm_campaign=element-index" target = "_blank" >
< img width = "150px" src = "https://user-images.githubusercontent.com/10095631/35603534-bb24470c-0678-11e8-8bcc-17ceaef8cbef.png" >
< / a >
< / td >
2018-06-13 17:51:42 +08:00
< td align = "center" valign = "middle" >
< a href = "https://bitsrc.io/" target = "_blank" >
< img width = "150px" src = "https://user-images.githubusercontent.com/10095631/41342907-e44e7196-6f2f-11e8-92f2-47702dc8f059.png" >
< / a >
< / td >
2018-01-31 11:22:05 +08:00
< / tr >
< / tbody >
< / table >
2017-12-18 17:38:51 +08:00
2016-09-21 18:45:29 +08:00
## Links
2017-10-25 11:58:58 +08:00
- Homepage and documentation
2018-03-15 10:57:45 +08:00
- [International users ](http://element.eleme.io/#/en-US )
- [Chinese users ](http://element-cn.eleme.io/#/zh-CN )
- [Spanish users ](http://element.eleme.io/#/es )
2019-02-21 16:35:34 +08:00
- [French users ](http://element.eleme.io/#/fr-FR )
2016-12-08 22:36:55 +08:00
- [awesome-element ](https://github.com/ElementUI/awesome-element )
2016-11-16 14:09:25 +08:00
- [FAQ ](./FAQ.md )
2017-10-25 11:58:58 +08:00
- [Customize theme ](http://element.eleme.io/#/en-US/component/custom-theme )
- [Preview and generate theme online ](https://elementui.github.io/theme-chalk-preview )
2018-06-22 19:02:31 +08:00
- [Element for React ](https://github.com/elemefe/element-react )
2018-01-26 11:24:09 +08:00
- [Element for Angular ](https://github.com/ElemeFE/element-angular )
2017-06-07 11:47:11 +08:00
- [Atom helper ](https://github.com/ElemeFE/element-helper )
2018-02-07 10:29:20 +08:00
- [Visual Studio Code helper ](https://github.com/ElemeFE/vscode-element-helper )
2017-10-25 11:58:58 +08:00
- Starter kit
2017-04-03 19:50:19 +08:00
- [element-starter ](https://github.com/ElementUI/element-starter )
- [element-in-laravel-starter ](https://github.com/ElementUI/element-in-laravel-starter )
2018-03-15 10:57:45 +08:00
- [Design resources ](https://github.com/ElementUI/Resources )
- Gitter
- [International users ](https://gitter.im/element-en/Lobby )
- [Chinese users ](https://gitter.im/ElemeFE/element )
2016-09-03 20:30:59 +08:00
2016-09-21 18:45:29 +08:00
## Install
2016-07-27 14:15:02 +08:00
```shell
2016-11-09 17:36:17 +08:00
npm install element-ui -S
2016-07-27 14:15:02 +08:00
```
## Quick Start
``` javascript
import Vue from 'vue'
import Element from 'element-ui'
Vue.use(Element)
// or
import {
Select,
Button
// ...
} from 'element-ui'
2016-09-06 12:01:53 +08:00
Vue.component(Select.name, Select)
Vue.component(Button.name, Button)
2016-07-27 14:15:02 +08:00
```
2016-11-16 14:09:25 +08:00
For more information, please refer to [Quick Start ](http://element.eleme.io/#/en-US/component/quickstart ) in our documentation.
2016-07-27 14:15:02 +08:00
2016-09-24 18:09:09 +08:00
## Browser Support
2017-10-27 11:30:04 +08:00
Modern browsers and Internet Explorer 10+.
2016-09-24 18:09:09 +08:00
2016-09-07 15:38:19 +08:00
## Development
2016-10-18 17:05:39 +08:00
Skip this part if you just want to use Element.
2016-09-07 15:38:19 +08:00
2019-02-21 16:35:34 +08:00
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 ) | [Français ](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.fr-FR.md )) to see how to run this project.
2016-09-03 20:30:59 +08:00
2016-09-01 14:17:01 +08:00
## Changelog
2016-09-24 20:26:03 +08:00
Detailed changes for each release are documented in the [release notes ](https://github.com/ElemeFE/element/releases ).
2016-09-01 14:17:01 +08:00
2016-10-18 17:05:39 +08:00
## FAQ
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.
2016-09-07 12:40:16 +08:00
## Contribution
2019-02-21 16:35:34 +08:00
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 ) | [Français ](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.fr-FR.md )) before making a pull request.
2016-09-07 12:40:16 +08:00
2019-01-30 11:59:06 +08:00
[](https://issuehunt.io/repos/67274736)
2016-12-06 16:05:38 +08:00
## Special Thanks
2017-12-12 12:45:09 +08:00
English documentation is brought to you by SwiftGG Translation Team:
2016-12-06 16:05:38 +08:00
- [raychenfj ](https://github.com/raychenfj )
- [kevin ](http://thekevin.cn/ )
- [曾小涛 ](https://github.com/zengxiaotao )
- [湾仔王二 ](https://github.com/wanzaiwanger )
- [BlooDLine ](http://www.ibloodline.com/ )
2016-12-06 18:29:37 +08:00
- [陈铭嘉 ](https://chenmingjia.github.io/ )
2016-12-06 16:05:38 +08:00
- [千叶知风 ](http://mpc6.com/ )
- [梁杰 ](http://numbbbbb.com )
- [Changing ](https://github.com/sunzhuo11 )
- [mmoaay ](https://github.com/mmoaay )
2017-12-12 12:45:09 +08:00
Spanish documentation is made possible by these community developers:
- [adavie1 ](https://github.com/adavie1 )
- [carmencitaqiu ](https://github.com/carmencitaqiu )
- [coderdiaz ](https://github.com/coderdiaz )
- [fedegar33 ](https://github.com/fedegar33 )
- [Gonzalo2310 ](https://github.com/Gonzalo2310 )
- [lesterbx ](https://github.com/lesterbx )
- [ProgramerGuy ](https://github.com/ProgramerGuy )
- [SantiagoGdaR ](https://github.com/SantiagoGdaR )
- [sigfriedCub1990 ](https://github.com/sigfriedCub1990 )
- [thechosenjuan ](https://github.com/thechosenjuan )
2019-05-07 11:35:54 +08:00
French documentation is made possible by these community developers:
- [smalesys ](https://github.com/smalesys )
2019-06-25 10:25:18 +08:00
- [blombard ](https://github.com/blombard )
2019-05-07 11:35:54 +08:00
2016-12-20 11:51:52 +08:00
## Backers
Support us with a monthly donation and help us continue our activities. [[Become a backer ](https://opencollective.com/element#backer )]
< a href = "https://opencollective.com/element/backer/0/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/1/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/2/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/3/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/4/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/5/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/6/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/7/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/8/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/9/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/9/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/10/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/10/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/11/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/11/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/12/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/12/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/13/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/13/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/14/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/14/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/15/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/15/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/16/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/16/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/17/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/17/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/18/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/18/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/19/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/19/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/20/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/20/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/21/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/21/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/22/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/22/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/23/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/23/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/24/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/24/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/25/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/25/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/26/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/26/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/27/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/27/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/28/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/28/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/backer/29/website" target = "_blank" > < img src = "https://opencollective.com/element/backer/29/avatar.svg" > < / a >
## Sponsors
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 )]
< a href = "https://opencollective.com/element/sponsor/0/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/1/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/2/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/3/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/4/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/5/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/6/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/7/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/8/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/9/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/9/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/10/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/10/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/11/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/11/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/12/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/12/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/13/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/13/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/14/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/14/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/15/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/15/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/16/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/16/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/17/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/17/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/18/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/18/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/19/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/19/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/20/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/20/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/21/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/21/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/22/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/22/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/23/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/23/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/24/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/24/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/25/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/25/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/26/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/26/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/27/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/27/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/28/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/28/avatar.svg" > < / a >
< a href = "https://opencollective.com/element/sponsor/29/website" target = "_blank" > < img src = "https://opencollective.com/element/sponsor/29/avatar.svg" > < / a >
2019-09-02 11:34:24 +08:00
## Join Discussion Group
2019-01-02 17:00:32 +08:00
2019-09-02 11:34:24 +08:00
Scan the QR code using [Dingtalk App ](https://www.dingtalk.com/ ) to join in discussion group :
2019-01-02 17:00:32 +08:00
2020-09-15 15:16:14 +08:00
< img alt = "Join Discusion Group" src = "https://user-images.githubusercontent.com/17680888/93177882-0ae92d80-f766-11ea-870d-3fa2d7f06454.png" width = "300" >
2016-12-20 10:34:10 +08:00
2016-07-27 14:15:02 +08:00
## LICENSE
2018-01-14 19:16:40 +08:00
[MIT ](LICENSE )
