element/README.md

71 lines
3.0 KiB
Markdown
Raw Normal View History

2016-09-09 21:40:35 +08:00
# Element
[![Build Status](https://travis-ci.org/ElemeFE/element.svg?branch=master)](https://travis-ci.org/ElemeFE/element)
2016-10-27 23:25:03 +08:00
[![Coverage Status](https://coveralls.io/repos/github/ElemeFE/element/badge.svg?branch=master)](https://coveralls.io/github/ElemeFE/element?branch=master)
[![CDNJS](https://img.shields.io/cdnjs/v/element-ui.svg)](https://cdnjs.com/libraries/element-ui)
2016-09-09 21:40:35 +08:00
[![npm package](https://img.shields.io/npm/v/element-ui.svg)](https://www.npmjs.org/package/element-ui)
[![NPM downloads](http://img.shields.io/npm/dm/element-ui.svg)](https://npmjs.org/package/element-ui)
![JS gzip size](http://img.badgesize.io/https://unpkg.com/element-ui/lib/index.js?compression=gzip&label=gzip%20size:%20JS)
![CSS gzip size](http://img.badgesize.io/https://unpkg.com/element-ui/lib/theme-default/index.css?compression=gzip&label=gzip%20size:%20CSS)
2016-09-09 21:32:31 +08:00
[![Join the chat at https://gitter.im/ElemeFE/element](https://badges.gitter.im/ElemeFE/element.svg)](https://gitter.im/ElemeFE/element?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2016-09-09 21:40:35 +08:00
2016-11-16 14:09:25 +08:00
> A Vue.js 2.0 UI Toolkit for Web.
2016-07-27 14:15:02 +08:00
## Links
- [Home Page](http://element.eleme.io/)
- [Docs](http://element.eleme.io/#/component)
2016-11-16 14:09:25 +08:00
- [FAQ](./FAQ.md)
2016-11-27 14:57:44 +08:00
- [Customize Theme](http://element.eleme.io/#/en-US/component/custom-theme)
2016-10-31 12:25:19 +08:00
- 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
2016-09-03 20:30:59 +08:00
## Install
2016-07-27 14:15:02 +08:00
```shell
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
Modern browsers and Internet Explorer 9+.
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
2016-10-18 17:05:39 +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.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
2016-09-07 15:11:50 +08:00
Please make sure to read the [Contributing Guide](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.md) before making a pull request.
2016-09-07 12:40:16 +08:00
2016-07-27 14:15:02 +08:00
## LICENSE
MIT