Go to file
2020-11-09 14:54:00 +08:00
.github ci: add master auto build web (#559) 2020-11-09 14:54:00 +08:00
build build: fix build bundle (#545) 2020-11-05 19:11:04 +08:00
packages docs: update i18n (#555) 2020-11-09 14:53:43 +08:00
public
scripts chore(core): deprecate storybook (#343) 2020-09-23 20:18:11 +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: update i18n (#555) 2020-11-09 14:53:43 +08:00
.editorconfig
.eslintrc.js feat(core): add jsx support 2020-09-15 13:53:41 +08:00
.gitattributes
.gitignore fix: fix table tooltip (#438) 2020-10-20 11:47:02 +08:00
.npmrc
.prettierrc.js Feat/carousel (#151) 2020-09-15 10:50:32 +08:00
CHANGELOG.en-US.md
CHANGELOG.es.md
CHANGELOG.fr-FR.md
CHANGELOG.zh-CN.md
CODE_OF_CONDUCT.md
commitlint.config.js
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
package.json 1.0.1-alpha.14 2020-11-04 17:04:46 +08:00
README.md chore: update logo 2020-10-14 14:26:12 +08:00
tsconfig.json fix(types): remove __test__ from ignore (#480) 2020-10-27 17:31:08 +08:00
yarn.lock build: build esm bundle & esm components (#518) 2020-10-30 23:26:57 +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