Migrated repository
Go to file
2021-05-06 19:35:29 +08:00
.github test: add ssr test (#1261) 2021-01-12 11:00:37 +08:00
build fix(project): fix/1778-import-on-demand-not-working (#1788) 2021-04-09 10:00:21 +08:00
packages fix(drawer): add modal false div class (#1932) 2021-05-06 19:35:29 +08:00
scripts fix: not generate code hint files when publish-npm (#1802) 2021-04-11 21:05:59 +08:00
typings fix: Module @vue/test-utils has no exported members (#1139) 2020-12-31 10:42:38 +08:00
website fix(image): fix image Add the dom of the preview picture to the body (#1577) 2021-04-26 11:54: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 chore: remove an repetitive file in .gitignore (#1673) 2021-03-22 09:09:14 +08:00
.prettierrc.js Feat/carousel (#151) 2020-09-15 10:50:32 +08:00
babel.config.js fix(build): fix utils esm build (#720) 2020-11-28 18:56:14 +08:00
CHANGELOG.en-US.md chore: update changelog (#1904) 2021-04-26 15:59:51 +08:00
CHANGELOG.es.md chore: update changelog (#1904) 2021-04-26 15:59:51 +08:00
CHANGELOG.fr-FR.md chore: update changelog (#1904) 2021-04-26 15:59:51 +08:00
CHANGELOG.jp.md chore: update changelog (#1904) 2021-04-26 15:59:51 +08:00
CHANGELOG.zh-CN.md chore: update changelog (#1904) 2021-04-26 15:59:51 +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 chore: fix gen type (#1762) 2021-04-06 15:53:17 +08:00
README.md Update README.md 2020-11-30 12:43:20 +08:00
tsconfig.json fix(types): remove __test__ from ignore (#480) 2020-10-27 17:31:08 +08:00
yarn.lock workflow: Auto generate code hint files from the docs (#1749) 2021-04-06 11:41:02 +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.

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