2299f882ccc73da38607f7ca31f1e3767177d22f5f964ddf47e7d507b8d55251d9e123f77b3ac5b760b628ed78cde535d062975a6728089427a00f781eafb9 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. <p align="center">
  2. <img src="https://cdn.rawgit.com/ElemeFE/element/dev/element_logo.svg">
  3. </p>
  4. <p align="center">
  5. <a href="https://travis-ci.org/ElemeFE/element">
  6. <img src="https://travis-ci.org/ElemeFE/element.svg?branch=master">
  7. </a>
  8. <a href="https://coveralls.io/github/ElemeFE/element?branch=master">
  9. <img src="https://coveralls.io/repos/github/ElemeFE/element/badge.svg?branch=master">
  10. </a>
  11. <a href="https://cdnjs.com/libraries/element-ui">
  12. <img src="https://img.shields.io/cdnjs/v/element-ui.svg">
  13. </a>
  14. <a href="https://www.npmjs.org/package/element-ui">
  15. <img src="https://img.shields.io/npm/v/element-ui.svg">
  16. </a>
  17. <a href="https://npmcharts.com/compare/element-ui?minimal=true">
  18. <img src="http://img.shields.io/npm/dm/element-ui.svg">
  19. </a>
  20. <br>
  21. <a href="http://img.badgesize.io/https://unpkg.com/element-ui/lib/index.js?compression=gzip&label=gzip%20size:%20JS">
  22. <img src="http://img.badgesize.io/https://unpkg.com/element-ui/lib/index.js?compression=gzip&label=gzip%20size:%20JS">
  23. </a>
  24. <a href="http://img.badgesize.io/https://unpkg.com/element-ui/lib/theme-chalk/index.css?compression=gzip&label=gzip%20size:%20CSS">
  25. <img src="http://img.badgesize.io/https://unpkg.com/element-ui/lib/theme-chalk/index.css?compression=gzip&label=gzip%20size:%20CSS">
  26. </a>
  27. <a href="#backers">
  28. <img src="https://opencollective.com/element/backers/badge.svg">
  29. </a>
  30. <a href="#sponsors">
  31. <img src="https://opencollective.com/element/sponsors/badge.svg">
  32. </a>
  33. <a href="LICENSE">
  34. <img src="https://img.shields.io/badge/License-MIT-yellow.svg">
  35. </a>
  36. </p>
  37. > A Vue.js 2.0 UI Toolkit for Web.
  38. Element will stay with Vue 2.x
  39. For Vue 3.0, we recommend using [Element Plus](https://github.com/element-plus/element-plus)(Element Plus is a community develop project)
  40. For MiniProgram development, we recommend using [MorJS](https://github.com/eleme/morjs)
  41. ## Links
  42. - Homepage and documentation
  43. - [International users](http://element.eleme.io/#/en-US)
  44. - [Chinese users](http://element.eleme.io/#/zh-CN)
  45. - [Spanish users](http://element.eleme.io/#/es)
  46. - [French users](http://element.eleme.io/#/fr-FR)
  47. - [awesome-element](https://github.com/ElementUI/awesome-element)
  48. - [FAQ](./FAQ.md)
  49. - [Vue.js 3.0 migration](https://github.com/element-plus/element-plus)
  50. - [Customize theme](http://element.eleme.io/#/en-US/component/custom-theme)
  51. - [Preview and generate theme online](https://elementui.github.io/theme-chalk-preview)
  52. - [Element for React](https://github.com/elemefe/element-react)
  53. - [Element for Angular](https://github.com/ElemeFE/element-angular)
  54. - [Atom helper](https://github.com/ElemeFE/element-helper)
  55. - [Visual Studio Code helper](https://github.com/ElemeFE/vscode-element-helper)
  56. - Starter kit
  57. - [element-starter](https://github.com/ElementUI/element-starter)
  58. - [element-in-laravel-starter](https://github.com/ElementUI/element-in-laravel-starter)
  59. - [Design resources](https://github.com/ElementUI/Resources)
  60. - Gitter
  61. - [International users](https://gitter.im/element-en/Lobby)
  62. - [Chinese users](https://gitter.im/ElemeFE/element)
  63. ## Install
  64. ```shell
  65. npm install element-ui -S
  66. ```
  67. ## Quick Start
  68. ``` javascript
  69. import Vue from 'vue'
  70. import Element from 'element-ui'
  71. Vue.use(Element)
  72. // or
  73. import {
  74. Select,
  75. Button
  76. // ...
  77. } from 'element-ui'
  78. Vue.component(Select.name, Select)
  79. Vue.component(Button.name, Button)
  80. ```
  81. For more information, please refer to [Quick Start](http://element.eleme.io/#/en-US/component/quickstart) in our documentation.
  82. ## Browser Support
  83. Modern browsers and Internet Explorer 10+.
  84. ## Development
  85. Skip this part if you just want to use Element.
  86. 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.
  87. ## Changelog
  88. Detailed changes for each release are documented in the [release notes](https://github.com/ElemeFE/element/releases).
  89. ## FAQ
  90. 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.
  91. ## Contribution
  92. 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.
  93. ## Special Thanks
  94. English documentation is brought to you by SwiftGG Translation Team:
  95. - [raychenfj](https://github.com/raychenfj)
  96. - [kevin](http://thekevin.cn/)
  97. - [曾小涛](https://github.com/zengxiaotao)
  98. - [湾仔王二](https://github.com/wanzaiwanger)
  99. - [BlooDLine](http://www.ibloodline.com/)
  100. - [陈铭嘉](https://chenmingjia.github.io/)
  101. - [千叶知风](http://mpc6.com/)
  102. - [梁杰](http://numbbbbb.com)
  103. - [Changing](https://github.com/sunzhuo11)
  104. - [mmoaay](https://github.com/mmoaay)
  105. Spanish documentation is made possible by these community developers:
  106. - [adavie1](https://github.com/adavie1)
  107. - [carmencitaqiu](https://github.com/carmencitaqiu)
  108. - [coderdiaz](https://github.com/coderdiaz)
  109. - [fedegar33](https://github.com/fedegar33)
  110. - [Gonzalo2310](https://github.com/Gonzalo2310)
  111. - [lesterbx](https://github.com/lesterbx)
  112. - [ProgramerGuy](https://github.com/ProgramerGuy)
  113. - [SantiagoGdaR](https://github.com/SantiagoGdaR)
  114. - [sigfriedCub1990](https://github.com/sigfriedCub1990)
  115. - [thechosenjuan](https://github.com/thechosenjuan)
  116. French documentation is made possible by these community developers:
  117. - [smalesys](https://github.com/smalesys)
  118. - [blombard](https://github.com/blombard)
  119. ## Join Discussion Group
  120. Scan the QR code using [Dingtalk App](https://www.dingtalk.com/) to join in discussion group :
  121. <img alt="Join Discusion Group" src="https://user-images.githubusercontent.com/17680888/93177882-0ae92d80-f766-11ea-870d-3fa2d7f06454.png" width="300">
  122. ## LICENSE
  123. [MIT](LICENSE)