mirror/element-plus
2
0
Fork 0
mirror of https://github.com/element-plus/element-plus.git synced 2024-11-27 02:01:15 +08:00
Code Issues Packages Projects Releases Wiki Activity
535 Commits 94 Branches 203 Tags 764 MiB
TypeScript 50.9%
Vue 48.2%
JavaScript 0.6%
Shell 0.3%
a9c8b7cebf
Go to file
zazzaz a9c8b7cebf build: update build
2020-11-23 09:50:30 +08:00
.github build: update build 2020-11-23 09:50:30 +08:00
build build: update conf 2020-11-22 22:36:42 +08:00
packages build: update build version 2020-11-22 21:56:33 +08:00
public
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
.eslintrc.js
.gitattributes
.gitignore build: update build version 2020-11-22 21:56:33 +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
lerna.json
LICENSE
package.json build: update build 2020-11-23 09:50:30 +08:00
README.md chore: add some github config (#612) 2020-11-18 22:41:22 +08:00
tsconfig.json
yarn.lock fix(pagination): pagination-not-emitting-size-change 2020-11-13 14:15:22 +08:00

README.md

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