Go to file
2020-10-27 14:36:34 +08:00
.github Update FUNDING.yml 2020-10-20 13:32:27 +08:00
build fix(build): remove vue extension 2020-10-21 15:51:44 +08:00
packages Revert "fix(switch): fix switch has outline (#469)" (#474) 2020-10-27 14:36:34 +08:00
public update 2020-07-21 18:18:44 +08:00
scripts chore(core): deprecate storybook (#343) 2020-09-23 20:18:11 +08:00
types fix build fails when using Vue 3 on top of typescript 2020-10-21 15:52:46 +08:00
typings Feat/form (#342) 2020-10-03 16:02:53 +08:00
website Doc/update link (#463) 2020-10-26 17:16:22 +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 fix: fix table tooltip (#438) 2020-10-20 11:47:02 +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
CHANGELOG.en-US.md feat: add website (#135) 2020-08-13 15:18:26 +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 feat: add website (#135) 2020-08-13 15:18:26 +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 feat(message-box): migrate MessageBox (#300) 2020-10-19 13:50:22 +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.10 2020-10-23 15:02:39 +08:00
README.md chore: update logo 2020-10-14 14:26:12 +08:00
tsconfig.json build(core): fix some type error 2020-10-09 20:24:53 +08:00
yarn.lock chore: update lock 2020-10-23 15:02:34 +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 Discord

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