mirror of
https://github.com/element-plus/element-plus.git
synced 2024-12-15 02:40:46 +08:00
.github | ||
build | ||
packages | ||
scripts | ||
typings | ||
website | ||
.editorconfig | ||
.eslintrc.js | ||
.gitattributes | ||
.gitignore | ||
.prettierrc.js | ||
babel.config.js | ||
CHANGELOG.en-US.md | ||
CHANGELOG.es.md | ||
CHANGELOG.fr-FR.md | ||
CHANGELOG.jp.md | ||
CHANGELOG.zh-CN.md | ||
CODE_OF_CONDUCT.md | ||
commitlint.config.js | ||
jest.config.js | ||
lerna.json | ||
LICENSE | ||
package.json | ||
README.md | ||
tsconfig.json | ||
yarn.lock |
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.
Special thanks to the generous sponsorship by:
Documentation
You can find for more details, API, and other docs on https://element-plus.org
国内加速镜像站点
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