Migrated repository
Go to file
2020-11-23 15:07:53 +08:00
.github build: update build 2020-11-23 09:50:30 +08:00
build Build/component (#656) 2020-11-23 13:55:48 +08:00
packages build: update build theme 2020-11-23 15:07:53 +08:00
scripts fix: correct bundle export (#630) 2020-11-20 20:24:16 +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(dialog): update dialog docs (#650) 2020-11-23 09:47:23 +08:00
.editorconfig feat/add-storybook 2020-07-24 19:20:37 +08:00
.eslintrc.js feat(core): add jsx support 2020-09-15 13:53:41 +08:00
.gitattributes chore: update type 2020-08-28 14:54:23 +08:00
.gitignore build: update build version 2020-11-22 21:56:33 +08:00
.npmrc fix(dev): update cz & husky 2020-07-24 23:25:03 +08:00
.prettierrc.js Feat/carousel (#151) 2020-09-15 10:50:32 +08:00
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 feat: add website (#135) 2020-08-13 15:18:26 +08:00
CHANGELOG.fr-FR.md feat: add website (#135) 2020-08-13 15:18:26 +08:00
CHANGELOG.zh-CN.md docs: update upload doc 2020-11-22 15:51:41 +08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2020-08-19 10:19:38 +08:00
commitlint.config.js chore(project): modify some lint rules 2020-08-19 23:15:51 +08:00
jest.config.js Update jest.config.js 2020-10-27 16:55:56 +08:00
lerna.json fix: change the value of version from 'indenpendent' to 'independent' (#338) 2020-09-23 09:18:41 +08:00
LICENSE Create LICENSE 2020-08-18 13:53:45 +08:00
package.json 1.0.1-alpha.19 2020-11-23 14:33:31 +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