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,595 Commits 89 Branches 205 Tags 784 MiB
TypeScript 51.3%
Vue 47.8%
JavaScript 0.6%
Shell 0.2%
5e00a390b9
Go to file
Aex 5e00a390b9
chore(project): avoid staging workflow running through fork (#3459)
2021-09-17 15:00:11 +08:00
.github chore(project): avoid staging workflow running through fork (#3459) 2021-09-17 15:00:11 +08:00
.husky refactor: upgrade to husky@7 & lint-staged@11 & commitlint@13 (#3239) 2021-09-05 01:33:56 +08:00
build chore: remove remaining website (#3444) 2021-09-17 09:07:30 +08:00
docs chore(docs): fix documentation line error (#3454) 2021-09-17 11:22:41 +08:00
packages fix: [el-form] button type is reset and reset form (#3445) 2021-09-17 11:15:49 +08:00
scripts epic(website): refactor website (#3426) 2021-09-17 00:18:50 +08:00
typings style: use prettier (#3228) 2021-09-04 19:29:28 +08:00
.editorconfig
.eslintignore test: fix test (#3109) 2021-08-27 19:13:37 +08:00
.eslintrc.js style: eslint enable prefer-template (#3414) 2021-09-17 09:18:24 +08:00
.gitattributes chore(project): improve prettier format (#3236) 2021-09-05 00:53:31 +08:00
.gitignore chore: remove remaining website (#3444) 2021-09-17 09:07:30 +08:00
.markdownlint.json
.npmrc
.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 Update CHANGELOG.en-US.md 2021-09-15 01:15:13 +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: remove remaining website (#3444) 2021-09-17 09:07:30 +08:00
README.md chore: remove remaining website (#3444) 2021-09-17 09:07:30 +08:00
tsconfig.dts.json style: use prettier (#3228) 2021-09-04 19:29:28 +08:00
tsconfig.json refactor(components): refactor button (#3341) 2021-09-12 19:38:48 +08:00
yarn.lock chore: remove remaining website (#3444) 2021-09-17 09:07:30 +08:00

README.md


Element Plus - A Vue.js 3 UI library

  • 💪 Vue 3 Composition API
  • 🔥 Written in TypeScript

Archived website

If you are looking for previous version website, here is the link.

Element Plus Documentation Archived

The new website is launched at 17th Sep 2021.

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:


Translations

Element Plus is translated to multiple languages, you can click the badge to help up update the translation or apply to become a proofreader Crowdin

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 docs:dev

the project will launch website for you to preview all existing component

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): [el-component-name] DESCRIPTION#[ISSUE]
# example: feat(components): [el-button] add type for form usage #1234

Licence

Element Plus is open source software licensed as MIT.

Contributors

This project wouldn't exist without our amazing contributors