element-plus

mirror of https://github.com/element-plus/element-plus.git synced 2024-11-27 02:01:15 +08:00

Go to file

Aex 2f9cdc74ce chore(project): improve prettier format (#3236 )		2021-09-05 00:53:31 +08:00
.github	chore(project): improve prettier format (#3236 )	2021-09-05 00:53:31 +08:00
build	style: use prettier (#3228 )	2021-09-04 19:29:28 +08:00
packages	chore(project): improve prettier format (#3236 )	2021-09-05 00:53:31 +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	chore(project): improve prettier format (#3236 )	2021-09-05 00:53:31 +08:00
.editorconfig
.eslintignore
.eslintrc.js	style: use prettier (#3228 )	2021-09-04 19:29:28 +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
.npmrc
.prettierignore	style: use prettier (#3228 )	2021-09-04 19:29:28 +08:00
.prettierrc	chore(project): improve prettier format (#3236 )	2021-09-05 00:53:31 +08:00
babel.config.js	style: use prettier (#3228 )	2021-09-04 19:29:28 +08:00
CHANGELOG.en-US.md	style: use prettier (#3228 )	2021-09-04 19:29:28 +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	style: use prettier (#3228 )	2021-09-04 19:29:28 +08:00
lerna.json	style: use prettier (#3228 )	2021-09-04 19:29:28 +08:00
LICENSE
package.json	chore(project): improve prettier format (#3236 )	2021-09-05 00:53:31 +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	style: use prettier (#3228 )	2021-09-04 19:29:28 +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.

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

Convert the item in https://github.com/element-plus/element-plus/projects/1 to an issue
Assign yourself to the issue
Author your component by generating new component command below
Migrate tests and docs
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