Migrated repository
Go to file
The Gitter Badger bc7f49a361 Add Gitter badge
2016-09-09 13:32:31 +00:00
.github fix contribution url 2016-09-07 15:21:35 +08:00
bin package: add lint script & lock vue version 2016-09-09 11:51:28 +08:00
examples Merge pull request #47 from Leopoldthecoder/master 2016-09-09 15:18:14 +08:00
packages Merge pull request #47 from Leopoldthecoder/master 2016-09-09 15:18:14 +08:00
scripts package: add lint script & lock vue version 2016-09-09 11:51:28 +08:00
src package: add lint script & lock vue version 2016-09-09 11:51:28 +08:00
.babelrc Use cooking@1.0.0-rc.2 2016-09-06 11:51:08 +08:00
.eslintignore Initial commit 2016-07-27 14:15:02 +08:00
.eslintrc update pagination 2016-07-29 17:46:16 +08:00
.gitignore Initial commit 2016-07-27 14:15:02 +08:00
.travis.yml update progress 2016-09-07 18:06:47 +08:00
CHANGELOG.md Update changelog 2016-09-09 15:20:55 +08:00
components.json menu item group 2016-08-23 11:32:37 +08:00
lerna.json Initial commit 2016-07-27 14:15:02 +08:00
LICENSE add LICENSE 2016-09-07 15:27:15 +08:00
Makefile package: remove postinstall hook 2016-09-09 13:49:20 +08:00
package.json 1.0.0-rc.3 2016-09-09 15:34:01 +08:00
README.md Add Gitter badge 2016-09-09 13:32:31 +00:00

Element Build Status npm package NPM downloads

Join the chat at https://gitter.im/ElemeFE/element

Desktop UI elements for Vue.js 2.0.

Docs

Coming soon

Demo

Demo will come with the documentation. Here is a preview of what a page based on Element looks like:

Usages

npm install element-ui@next

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 Select from 'element-ui/lib/theme-default/select.css'
import Button from 'element-ui/lib/button'
import Button from 'element-ui/lib/theme-default/button.css'

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

babel-plugin-component

.babelrc

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

Development

Recommend: node >= 4 npm >= 3

# development => install packages -> build icon etc. -> run webpack
$ npm run dev

# Recommended use `npminstall` to install packages, it is so fast
$ npm i npminstall -g
$ npminstall

# build => build all component
$ npm run dist

Changelog

Details changes for each release are documented in the release notes.

Contribution

Please make sure to read the Contributing Guide before making a pull request.

LICENSE

MIT