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,030 Commits 89 Branches 205 Tags 784 MiB
TypeScript 51.3%
Vue 47.8%
JavaScript 0.6%
Shell 0.2%
09902a75be
Go to file
jeremywu 09902a75be
chore(project): release/beta-42 (#1970) 
- update changelogs for preparing new release
2021-05-09 11:07:13 +08:00
.github
build fix(project): fix/1778-import-on-demand-not-working (#1788) 2021-04-09 10:00:21 +08:00
packages fix: use more reasonable type inference (#1963) 2021-05-09 10:46:11 +08:00
scripts fix: not generate code hint files when publish-npm (#1802) 2021-04-11 21:05:59 +08:00
typings
website docs(pagination): remove the deprecated .sync syntax (#1920) (#1957) 2021-05-09 10:35:49 +08:00
.editorconfig
.eslintrc.js
.gitattributes
.gitignore
.prettierrc.js
babel.config.js
CHANGELOG.en-US.md chore(project): release/beta-42 (#1970) 2021-05-09 11:07:13 +08:00
CHANGELOG.es.md chore(project): release/beta-42 (#1970) 2021-05-09 11:07:13 +08:00
CHANGELOG.fr-FR.md chore(project): release/beta-42 (#1970) 2021-05-09 11:07:13 +08:00
CHANGELOG.jp.md chore(project): release/beta-42 (#1970) 2021-05-09 11:07:13 +08:00
CHANGELOG.zh-CN.md chore(project): release/beta-42 (#1970) 2021-05-09 11:07:13 +08:00
CODE_OF_CONDUCT.md
commitlint.config.js
jest.config.js
lerna.json
LICENSE
package.json chore: fix gen type (#1762) 2021-04-06 15:53:17 +08:00
README.md chore: update ad (#1968) 2021-05-09 01:03:27 +08:00
tsconfig.json
yarn.lock workflow: Auto generate code hint files from the docs (#1749) 2021-04-06 11:41:02 +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.

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