Migrated repository
Go to file
2020-11-27 11:30:48 +08:00
.github Build/full (#668) 2020-11-24 14:58:56 +08:00
build chore: update build type 2020-11-27 11:19:13 +08:00
packages chore: update build type 2020-11-27 11:19:13 +08:00
scripts chore(project): adding a script for upgrading vue version (#660) 2020-11-23 17:51:51 +08:00
types feat(cascader): refactor done (#435) 2020-10-30 23:26:33 +08:00
typings feat(cascader): refactor done (#435) 2020-10-30 23:26:33 +08:00
website docs(container): update container docs (#684) 2020-11-26 23:12:06 +08:00
.editorconfig
.eslintrc.js
.gitattributes
.gitignore build: add type (#685) 2020-11-26 23:09:31 +08:00
.npmrc
.prettierrc.js
babel.config.js build: optimize (#560) 2020-11-10 14:24:09 +08:00
CHANGELOG.en-US.md docs: update upload doc 2020-11-22 15:51:41 +08:00
CHANGELOG.es.md
CHANGELOG.fr-FR.md
CHANGELOG.zh-CN.md docs: update upload doc 2020-11-22 15:51:41 +08:00
CODE_OF_CONDUCT.md
commitlint.config.js
jest.config.js Update jest.config.js 2020-10-27 16:55:56 +08:00
lerna.json
LICENSE
package.json 1.0.1-alpha.23 2020-11-27 11:30:48 +08:00
README.md chore: add some github config (#612) 2020-11-18 22:41:22 +08:00
tsconfig.json fix(types): remove __test__ from ignore (#480) 2020-10-27 17:31:08 +08:00
yarn.lock build: update theme build 2020-11-23 14:33:20 +08:00

Element Plus - A Vue.js 3.0 UI library

  • 💪 Vue 3.0 Composition API
  • 🔥 Written in TypeScript

This project is still under heavy development. Feel free to join us and make your first pull request.

Edit element-plus


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