element-plus

mirror of https://github.com/element-plus/element-plus.git synced 2024-12-21 02:50:11 +08:00

Go to file

iamkun 9f8bfdb939 Update CHANGELOG.en-US.md		2021-08-25 01:27:45 +08:00
.github	fix(build): github release CI issue (#3023 )	2021-08-24 16:31:30 +08:00
build	fix(build) fix rollup full bundile issue (#3034 )	2021-08-25 01:22:03 +08:00
packages	fix(build) fix rollup full bundile issue (#3034 )	2021-08-25 01:22:03 +08:00
scripts	fix(build): upgrade vue to 3.2.x (#3031 )	2021-08-25 00:18:06 +08:00
typings	refactor: update package path and bundle folder (#3016 )	2021-08-24 13:36:48 +08:00
website	refactor: update package path and bundle folder (#3016 )	2021-08-24 13:36:48 +08:00
.editorconfig
.eslintignore	refactor: update package path and bundle folder (#3016 )	2021-08-24 13:36:48 +08:00
.eslintrc.js	style: add no-multi-spaces rule (#2345 )	2021-06-25 16:25:54 +08:00
.gitattributes	chore: update type	2020-08-28 14:54:23 +08:00
.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	chore(style): lint scss by prettier (#2515 )	2021-07-14 09:27:52 +08:00
babel.config.js	fix(build): fix utils esm build (#720 )	2020-11-28 18:56:14 +08:00
CHANGELOG.en-US.md	Update CHANGELOG.en-US.md	2021-08-25 01:27:45 +08:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2020-08-19 10:19:38 +08:00
commitlint.config.js	release(project): release 1.0.2-beta.64 (#2733 )	2021-07-28 12:25:27 +08:00
jest.config.js	Update jest.config.js	2020-10-27 16:55:56 +08:00
lerna.json	fix: change the value of version from 'indenpendent' to 'independent' (#338 )	2020-09-23 09:18:41 +08:00
LICENSE	Create LICENSE	2020-08-18 13:53:45 +08:00
package.json	fix(build) fix rollup full bundile issue (#3034 )	2021-08-25 01:22:03 +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) fix rollup full bundile issue (#3034 )	2021-08-25 01:22:03 +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(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