13 KiB
# 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-default/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) [![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.
Special thanks to the generous sponsorship by:
Links
- Home Page
- Docs
- awesome-element
- FAQ
- Customize Theme
- Starter Kit
- element-starter
- element-cooking-starter
- element-in-laravel-starter
- Design resources
- Boilerplate for bug reports
- CodePen
- JSFiddle
- Mint UI - Mobile UI elements for Vue.js
Install
npm install element-ui -S
Quick Start
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 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 to see how to run this project.
Changelog
Detailed changes for each release are documented in the release notes.
FAQ
We have collected some frequently asked questions. Before reporting an issue, please search if the FAQ has the answer to your problem.
Contribution
Please make sure to read the Contributing Guide before making a pull request.
Special Thanks
English documentation is brought to you by SwiftGG Translation Team. Our special thanks go to these fellows:
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]
Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]
LICENSE
MIT