Go to file
jeremywu 59bcb722e9
chore(project): chore/bumping-dep-versions (#1214)
- Bumping dep versions to get rid of Vulnerability
2021-01-07 11:22:54 +08:00
.github fix: fix timepicker keyevent bug (#1151) 2020-12-31 11:12:52 +08:00
build build(build): buid/add-locale-theme-in-es-build (#1132) 2020-12-27 18:05:32 +08:00
packages fix(menu): fix/menu-item-not-expanding-correctly (#1212) 2021-01-06 23:24:41 +08:00
scripts chore(project): chore/bumping-vue-version (#1159) 2020-12-31 11:11:45 +08:00
typings fix: Module @vue/test-utils has no exported members (#1139) 2020-12-31 10:42:38 +08:00
website docs: update contain doc style (#1204) 2021-01-06 14:12:22 +08:00
.editorconfig
.eslintrc.js
.gitattributes
.gitignore build(core): core/bundling-opt (#1118) 2020-12-27 14:16:18 +08:00
.prettierrc.js
babel.config.js fix(build): fix utils esm build (#720) 2020-11-28 18:56:14 +08:00
CHANGELOG.en-US.md chore: update changelog 2021-01-05 16:55:16 +08:00
CHANGELOG.es.md chore: update changelog 2021-01-05 16:55:16 +08:00
CHANGELOG.fr-FR.md chore: update changelog 2021-01-05 16:55:16 +08:00
CHANGELOG.jp.md chore: update changelog 2021-01-05 16:55:16 +08:00
CHANGELOG.zh-CN.md chore: update changelog 2021-01-05 16:55:16 +08:00
CODE_OF_CONDUCT.md
commitlint.config.js
jest.config.js
lerna.json
LICENSE
package.json chore(project): chore/bumping-dep-versions (#1214) 2021-01-07 11:22:54 +08:00
README.md Update README.md 2020-11-30 12:43:20 +08:00
tsconfig.json
yarn.lock chore(project): chore/bumping-dep-versions (#1214) 2021-01-07 11:22:54 +08:00


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.

Edit element-plus


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

  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

$ 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