Element Plus - A Vue.js 3.0 UI library
- 💪 Vue 3.0 Composition API
- 🔥 Written in TypeScript
## Status: Beta
This project is still under heavy development. Feel free to join us and make your first pull request.
[](https://codesandbox.io/s/element-plus-ncxnt?fontsize=14&hidenavigation=1&theme=dark)
Special thanks to the generous sponsorship by:
---
## Documentation
You can find for more details, API, and other docs on [https://element-plus.org](https://element-plus.org/)
国内[加速镜像站点](https://element-plus.gitee.io/)
Join our [Discord](https://discord.link/ElementPlus) to start communicating with everybody.
## Breaking change list
You can find the breaking change list here: [Breaking Change List](https://github.com/element-plus/element-plus/issues/162).
## Bootstrap project
With command
```bash
$ yarn bootstrap
```
the project will install all dependencies and run `lerna bootstrap` to initialize the project
## Website preview
With command
```bash
$ 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
```bash
$ yarn website-dev:play
//source file: ./website/play/index.vue
```
## Component migration process
1. Convert the item in https://github.com/element-plus/element-plus/projects/1 to an issue
2. Assign yourself to the issue
3. Author your component by generating new component command below
4. Migrate tests and docs
5. Open a new pull request, fill in the component issue link in 1
## Generate new component
With command
```bash
$ 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
```bash
yarn cz
```
Example
```
# [TYPE](SCOPE): [el-component-name] DESCRIPTION#[ISSUE]
# example: feat(components): [el-button] add type for form usage #1234
```
## Licence
Element Plus is open source software licensed as
[MIT](https://github.com/element-plus/element-plus/blob/master/LICENSE).
## Contributors
This project wouldn't exist without our amazing contributors
