mirror/element-plus
2
0
Fork 0
mirror of https://github.com/element-plus/element-plus.git synced 2024-12-21 02:50:11 +08:00
Code Issues Packages Projects Releases Wiki Activity
1,433 Commits 89 Branches 205 Tags 784 MiB
TypeScript 51.3%
Vue 47.8%
JavaScript 0.6%
Shell 0.2%
85849419f1
Go to file
iamkun 85849419f1
Update CHANGELOG.en-US.md
2021-08-25 18:02:29 +08:00
.github fix(build): github release CI issue (#3023) 2021-08-24 16:31:30 +08:00
build fix missing folders and umd locale builds and i18n docs for umd builds 2021-08-25 17:07:06 +08:00
packages fix: stop pinning vue peer dependency version (#3051) 2021-08-25 17:34:57 +08:00
scripts fix missing folders and umd locale builds and i18n docs for umd builds 2021-08-25 17:07:06 +08:00
typings refactor: update package path and bundle folder (#3016) 2021-08-24 13:36:48 +08:00
website fixed resolve font path errors (#3048) 2021-08-25 17:38:24 +08:00
.editorconfig
.eslintignore refactor: update package path and bundle folder (#3016) 2021-08-24 13:36:48 +08:00
.eslintrc.js
.gitattributes
.gitignore refactor: update package path and bundle folder (#3016) 2021-08-24 13:36:48 +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
.prettierrc.js
babel.config.js
CHANGELOG.en-US.md Update CHANGELOG.en-US.md 2021-08-25 18:02:29 +08:00
CODE_OF_CONDUCT.md
commitlint.config.js release(project): release 1.0.2-beta.64 (#2733) 2021-07-28 12:25:27 +08:00
jest.config.js
lerna.json
LICENSE
package.json fix(build): unpin vue compiler version (#3055) 2021-08-25 17:47:25 +08:00
README.md chore: update readme (#2619) 2021-07-22 19:24:22 +08:00
tsconfig.dts.json refactor: update package path and bundle folder (#3016) 2021-08-24 13:36:48 +08:00
tsconfig.json refactor: update package path and bundle folder (#3016) 2021-08-24 13:36:48 +08:00
yarn.lock fix(build): unpin vue compiler version (#3055) 2021-08-25 17:47:25 +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(button):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