# Element [![Build Status](https://travis-ci.org/ElemeFE/element.svg?branch=master)](https://travis-ci.org/ElemeFE/element) [![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) [![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-chalk/index.css?compression=gzip&label=gzip%20size:%20CSS) [![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)(Chinese) [![Join the chat at https://gitter.im/element-en/Lobby](https://badges.gitter.im/element-en/Lobby.svg)](https://gitter.im/element-en/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)(English) [![OpenCollective](https://opencollective.com/element/backers/badge.svg)](#backers) [![OpenCollective](https://opencollective.com/element/sponsors/badge.svg)](#sponsors) > A Vue.js 2.0 UI Toolkit for Web. Sponsor ## Links - [Home Page](http://element.eleme.io/) - [Docs](http://element.eleme.io/#/component) - [awesome-element](https://github.com/ElementUI/awesome-element) - [FAQ](./FAQ.md) - [Customize Theme](http://element.eleme.io/#/en-US/component/custom-theme) - [Preview and generate theme online](https://elementui.github.io/theme-preview) - [Element for React](https://github.com/eleme/element-react) - [Atom helper](https://github.com/ElemeFE/element-helper) - 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.zh-CN.md) | [English](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.en-US.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.zh-CN.md) | [English](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.en-US.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) ## Donation If you find Element useful, you can buy us a cup of coffee ## Backers Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/element#backer)] ## 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)] ## LICENSE MIT