Go to file
2021-06-30 15:07:26 +08:00
.github fix: Highlighted the search results of document (#2382) 2021-06-30 14:36:41 +08:00
build chore: update search (#2390) 2021-06-30 15:07:26 +08:00
packages feat(virtual-list): template string to render function (#2388) 2021-06-30 14:31:18 +08:00
scripts fix(project): fix/upgrade-to-vue-3-1-1-and-with-bug-fix (#2220) 2021-06-11 18:20:49 +08:00
typings fix: Module @vue/test-utils has no exported members (#1139) 2020-12-31 10:42:38 +08:00
website chore: update search (#2390) 2021-06-30 15:07:26 +08:00
.editorconfig
.eslintrc.js style: add no-multi-spaces rule (#2345) 2021-06-25 16:25:54 +08:00
.gitattributes
.gitignore chore: remove an repetitive file in .gitignore (#1673) 2021-03-22 09:09:14 +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 (#2347) 2021-06-25 17:27:53 +08:00
CHANGELOG.es.md chore: update changelog (#2347) 2021-06-25 17:27:53 +08:00
CHANGELOG.fr-FR.md chore: update changelog (#2347) 2021-06-25 17:27:53 +08:00
CHANGELOG.jp.md chore: update changelog (#2347) 2021-06-25 17:27:53 +08:00
CHANGELOG.zh-CN.md chore: update changelog (#2347) 2021-06-25 17:27:53 +08:00
CODE_OF_CONDUCT.md
commitlint.config.js
jest.config.js
lerna.json
LICENSE
package.json fix: Highlighted the search results of document (#2382) 2021-06-30 14:36:41 +08:00
README.md chore: update ad (#1968) 2021-05-09 01:03:27 +08:00
tsconfig.json
yarn.lock Fix/table test (#2229) 2021-06-12 17:10:24 +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