ac7c226196
* chore(project): bump @babel/cli from 7.12.1 to 7.15.4 * chore(project): bump @babel/core from 7.11.6 to 7.15.5 * chore(project): bump @babel/plugin-proposal-class-properties to 7.14.5 * chore(project): bump @babel/plugin-transform-runtime to 7.15.0 * chore(project): bump @babel/preset-env from 7.11.5 to 7.15.4 * chore(project): bump @babel/preset-typescript from 7.10.4 to 7.15.0 * chore(project): bump babel-loader from 8.1.0 to 8.2.2 * chore(project): bump babel-plugin-module-resolver from 4.0.0 to 4.1.0 * chore(project): bump @popperjs/core from 2.4.4 to 2.10.1 * chore(project): update babel.config.js * chore(project): update jest.config.js * chore(project): bump @typescript-eslint/eslint-plugin to 4.30.0 * chore(project): bump @typescript-eslint/parser from 4.29.3 to 4.30.0 * chore(project): bump algoliasearch from 4.4.0 to 4.10.5 * chore(project): bump transliteration from 2.1.11 to 2.2.0 * chore(project): bump typescript from 4.3.5 to 4.4.2 * chore(project): bump esbuild from 0.12.5 to 0.12.25 * chore(project): bump file-loader from 6.1.0 to 6.2.0 * chore(project): bump rollup from 2.28.2 to 2.56.3 * chore(project): bump rollup-plugin-esbuild from 4.2.3 to 4.5.0 * chore(project): bump sass from 1.37.0 to 1.39.0 * chore(project): move sass & typescript to devDependencies |
||
---|---|---|
.github | ||
.husky | ||
build | ||
packages | ||
scripts | ||
typings | ||
website | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc.js | ||
.gitattributes | ||
.gitignore | ||
.markdownlint.json | ||
.npmrc | ||
.prettierignore | ||
.prettierrc | ||
babel.config.js | ||
CHANGELOG.en-US.md | ||
CODE_OF_CONDUCT.md | ||
commitlint.config.js | ||
jest.config.js | ||
lerna.json | ||
LICENSE | ||
package.json | ||
README.md | ||
tsconfig.dts.json | ||
tsconfig.json | ||
yarn.lock |
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