element-plus/element-plus
A Vue.js 3.0 UI Library
| repo name | element-plus/element-plus |
| repo link | https://github.com/element-plus/element-plus |
| homepage | https://element-plus.org/ |
| language | Vue |
| size (curr.) | 6868 kB |
| stars (curr.) | 2980 |
| created | 2020-07-21 |
| license | MIT License |
- 💪 Vue 3.0 Composition API
- 🔥 Written in TypeScript
This project is still under heavy development. Feel free to join us and make your first pull request.
Join our Discord to start communicating with everybody 
Bootstrap project
With command
$ yarn bootstrap
the project will install all dependencies and run lerna bootstrap to initialize the project
Website preview
With command
$ yarn website-dev
the project will launch website for you to preview all existing component
You can also use this command to start a blank page to debug
$ yarn website-dev:play
//source file: ./website/play/index.vue
Component migration process
- Convert the item in https://github.com/element-plus/element-plus/projects/1 to an issue
- Assign yourself to the issue
- Author your component by generating new component command below
- Migrate tests and docs
- Open a new pull request, fill in the component issue link in 1
Generate new component
With command
$ yarn gen component-name
Note the component-name must be in kebab-case, combining words by replacing each space with a dash.
Commit template
With command
yarn cz
Example
[TYPE](SCOPE):DESCRIPTION#[ISSUE]
# example feat(button):add type 'button' for form usage #1234
