Go to file
2021-07-28 10:16:33 +08:00
.github update ci node version 2021-07-23 16:46:53 +08:00
build build(project): update bundle strategy 2021-07-23 16:46:53 +08:00
packages refactor(backtop): migrate css var (#2711) 2021-07-28 10:16:33 +08:00
scripts fix(build): fix build script (#2683) 2021-07-26 12:47:02 +08:00
typings
website update i18n version (#2690) 2021-07-27 09:26:20 +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 chore(style): lint scss by prettier (#2515) 2021-07-14 09:27:52 +08:00
babel.config.js
CHANGELOG.en-US.md chore: update changelog 1.0.2-beta.63 (#2713) 2021-07-27 13:27:46 +08:00
CHANGELOG.es.md chore: update changelog 1.0.2-beta.63 (#2713) 2021-07-27 13:27:46 +08:00
CHANGELOG.fr-FR.md chore: update changelog 1.0.2-beta.63 (#2713) 2021-07-27 13:27:46 +08:00
CHANGELOG.jp.md chore: update changelog 1.0.2-beta.63 (#2713) 2021-07-27 13:27:46 +08:00
CHANGELOG.zh-CN.md chore: update changelog 1.0.2-beta.63 (#2713) 2021-07-27 13:27:46 +08:00
CODE_OF_CONDUCT.md
commitlint.config.js refactor(var): simplify checkbox var & move transition to root (#2729) 2021-07-28 09:16:44 +08:00
jest.config.js
lerna.json
LICENSE
package.json build(project): update bundle strategy 2021-07-23 16:46:53 +08:00
README.md chore: update readme (#2619) 2021-07-22 19:24:22 +08:00
tsconfig.json
yarn.lock build(project): update bundle strategy 2021-07-23 16:46:53 +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.

Breaking change list

You can find the breaking change list here: Breaking Change List.

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

Licence

ElementPlus is open source software licensed as MIT.

Contributors

This project wouldn't exist without our amazing contributors