element/README.md
2016-11-09 17:36:17 +08:00

3.5 KiB

Element

Build Status Coverage Status CDNJS npm package NPM downloads JS gzip size CSS gzip size Join the chat at https://gitter.im/ElemeFE/element

Desktop UI elements for Vue.js 2.0.

Install

npm install element-ui -S

Quick Start

use babel-plugin-component

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)

(roughly) to

import Vue from 'vue'
import Element from 'element-ui'
import 'element-ui/lib/theme-default/index.css'

Vue.use(Element)

// or
import Select from 'element-ui/lib/select'
import 'element-ui/lib/theme-default/select.css'
import Button from 'element-ui/lib/button'
import 'element-ui/lib/theme-default/button.css'

Vue.component(Select.name, Select)
Vue.component(Button.name, Button)

babel-plugin-component

.babelrc

{
  "plugins": [["component", [
    {
      "libraryName": "element-ui",
      "styleLibraryName": "theme-default"
    }
  ]]]
}

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.

LICENSE

MIT