mirror/element-plus
2
0
Fork 0
mirror of https://github.com/element-plus/element-plus.git synced 2024-12-27 03:01:14 +08:00
Code Issues Packages Projects Releases Wiki Activity
1,525 Commits 96 Branches 205 Tags 785 MiB
TypeScript 51.2%
Vue 47.8%
JavaScript 0.6%
Shell 0.3%
14e184531c
Go to file
啝裳 14e184531c
improvement(directives): add type declaration (#3310) 
and fix docs copy
close #3313
2021-09-09 19:41:10 +08:00
.github docs(other): modify contribution guide (#3315) 2021-09-09 17:35:11 +08:00
.husky refactor: upgrade to husky@7 & lint-staged@11 & commitlint@13 (#3239) 2021-09-05 01:33:56 +08:00
build style: use prettier (#3228) 2021-09-04 19:29:28 +08:00
packages improvement(directives): add type declaration (#3310) 2021-09-09 19:41:10 +08:00
scripts chore(build): remove unused package.json scripts (#3150) 2021-08-31 17:57:35 +08:00
typings style: use prettier (#3228) 2021-09-04 19:29:28 +08:00
website improvement(directives): add type declaration (#3310) 2021-09-09 19:41:10 +08:00
.editorconfig
.eslintignore test: fix test (#3109) 2021-08-27 19:13:37 +08:00
.eslintrc.js refactor(utils): improve debug warn (#3302) 2021-09-09 11:49:48 +08:00
.gitattributes chore(project): improve prettier format (#3236) 2021-09-05 00:53:31 +08:00
.gitignore chore: ignore all play files (#3226) 2021-09-04 09:52:50 +08:00
.markdownlint.json refactor: update package path and bundle folder (#3016) 2021-08-24 13:36:48 +08:00
.npmrc refactor: update package path and bundle folder (#3016) 2021-08-24 13:36:48 +08:00
.prettierignore chore(project): add coverage into prettier ignore (#3240) 2021-09-05 14:46:46 +08:00
.prettierrc chore(project): improve prettier format (#3236) 2021-09-05 00:53:31 +08:00
babel.config.js chore(project): upgrade dependencies to latest minor (#3242) 2021-09-05 19:57:35 +08:00
CHANGELOG.en-US.md chore: update prettier fix 2021-09-05 23:28:38 +08:00
CODE_OF_CONDUCT.md style: use prettier (#3228) 2021-09-04 19:29:28 +08:00
commitlint.config.js style: use prettier (#3228) 2021-09-04 19:29:28 +08:00
jest.config.js chore(project): upgrade dependencies to latest minor (#3242) 2021-09-05 19:57:35 +08:00
lerna.json style: use prettier (#3228) 2021-09-04 19:29:28 +08:00
LICENSE
package.json chore(project): update package.json (#3246) 2021-09-05 21:42:37 +08:00
README.md style: use prettier (#3228) 2021-09-04 19:29:28 +08:00
tsconfig.dts.json style: use prettier (#3228) 2021-09-04 19:29:28 +08:00
tsconfig.json refactor: enhance type definition (#3062) 2021-08-31 09:40:13 +08:00
yarn.lock chore(project): upgrade dependencies to latest minor (#3242) 2021-09-05 19:57:35 +08:00

README.md


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.

Breaking change list

You can find the breaking change list here: Breaking Change List.

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(components): add type 'button' for form usage #1234

Licence

ElementPlus is open source software licensed as MIT.

Contributors

This project wouldn't exist without our amazing contributors