mirror of https://github.com/ElemeFE/element
84 lines
3.5 KiB
Markdown
84 lines
3.5 KiB
Markdown
# Element
|
||
[](https://travis-ci.org/ElemeFE/element)
|
||
[](https://coveralls.io/github/ElemeFE/element?branch=master)
|
||
[](https://cdnjs.com/libraries/element-ui)
|
||
[](https://www.npmjs.org/package/element-ui)
|
||
[](https://npmjs.org/package/element-ui)
|
||

|
||

|
||
[](https://gitter.im/ElemeFE/element?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||
|
||
> A Vue.js 2.0 UI Toolkit for Web.
|
||
|
||
## Links
|
||
- [Home Page](http://element.eleme.io/)
|
||
- [Docs](http://element.eleme.io/#/component)
|
||
- [FAQ](./FAQ.md)
|
||
- [Customize Theme](http://element.eleme.io/#/en-US/component/custom-theme)
|
||
- Starter Kit
|
||
- [element-starter](https://github.com/ElementUI/element-starter)
|
||
- [element-cooking-starter](https://github.com/ElementUI/element-cooking-starter)
|
||
- [element-in-laravel-starter](https://github.com/ElementUI/element-in-laravel-starter)
|
||
- [Design resources](https://github.com/ElementUI/Resources)
|
||
- Boilerplate for bug reports
|
||
- [CodePen](https://codepen.io/anon/pen/ozYpNA)
|
||
- [JSFiddle](https://jsfiddle.net/gmve9d3p/)
|
||
- [Mint UI](https://github.com/ElemeFE/mint-ui) - Mobile UI elements for Vue.js
|
||
|
||
## Install
|
||
```shell
|
||
npm install element-ui -S
|
||
```
|
||
|
||
## Quick Start
|
||
``` javascript
|
||
import Vue from 'vue'
|
||
import Element from 'element-ui'
|
||
|
||
Vue.use(Element)
|
||
|
||
// or
|
||
import {
|
||
Select,
|
||
Button
|
||
// ...
|
||
} from 'element-ui'
|
||
|
||
Vue.component(Select.name, Select)
|
||
Vue.component(Button.name, Button)
|
||
```
|
||
For more information, please refer to [Quick Start](http://element.eleme.io/#/en-US/component/quickstart) in our documentation.
|
||
|
||
## Browser Support
|
||
Modern browsers and Internet Explorer 9+.
|
||
|
||
## Development
|
||
Skip this part if you just want to use Element.
|
||
|
||
For those who are interested in contributing to Element, please refer to our [contributing guide](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.md) to see how to run this project.
|
||
|
||
## Changelog
|
||
Detailed changes for each release are documented in the [release notes](https://github.com/ElemeFE/element/releases).
|
||
|
||
## 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.
|
||
|
||
## Contribution
|
||
Please make sure to read the [Contributing Guide](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.md) before making a pull request.
|
||
|
||
## Special Thanks
|
||
English documentation is brought to you by SwiftGG Translation Team. Our special thanks go to these fellows:
|
||
- [raychenfj](https://github.com/raychenfj)
|
||
- [kevin](http://thekevin.cn/)
|
||
- [曾小涛](https://github.com/zengxiaotao)
|
||
- [湾仔王二](https://github.com/wanzaiwanger)
|
||
- [BlooDLine](http://www.ibloodline.com/)
|
||
- [陈铭嘉](https://chenmingjia.github.io/)
|
||
- [千叶知风](http://mpc6.com/)
|
||
- [梁杰](http://numbbbbb.com)
|
||
- [Changing](https://github.com/sunzhuo11)
|
||
- [mmoaay](https://github.com/mmoaay)
|
||
|
||
## LICENSE
|
||
MIT
|