mirror/element-plus
2
0
Fork 0
mirror of https://github.com/element-plus/element-plus.git synced 2025-01-30 11:16:12 +08:00
Code Issues Packages Projects Releases Wiki Activity
961 Commits 95 Branches 207 Tags 805 MiB
TypeScript 51.5%
Vue 47.6%
JavaScript 0.6%
Shell 0.2%
87a16f24d3
Go to file
qiang 87a16f24d3
workflow: Auto generate code hint files from the docs (#1749) 
* chore: add components-helper

* docs: unified style

* docs: unified style

* docs: unified style

* docs: unified style

* chore: replace Accepted Values for icon

* chore: delete vetur folder

* chore: add components-helper

* docs: unified style

* docs: unified style

* docs: unified style

* docs: unified style

* chore: replace Accepted Values for icon

* chore: delete vetur folder
2021-04-06 11:41:02 +08:00
.github test: add ssr test (#1261) 2021-01-12 11:00:37 +08:00
build workflow: Auto generate code hint files from the docs (#1749) 2021-04-06 11:41:02 +08:00
packages fix(utils): fix isIE logic (#1757) 2021-04-06 11:27:30 +08:00
scripts build(project): project/bumping-vue-version (#1702) 2021-03-28 12:46:58 +08:00
typings fix: Module @vue/test-utils has no exported members (#1139) 2020-12-31 10:42:38 +08:00
website workflow: Auto generate code hint files from the docs (#1749) 2021-04-06 11:41:02 +08:00
.editorconfig
.eslintrc.js
.gitattributes
.gitignore chore: remove an repetitive file in .gitignore (#1673) 2021-03-22 09:09:14 +08:00
.prettierrc.js
babel.config.js
CHANGELOG.en-US.md docs(project): release/beta-1.0.36 (#1703) 2021-03-28 13:04:45 +08:00
CHANGELOG.es.md docs(project): release/beta-1.0.36 (#1703) 2021-03-28 13:04:45 +08:00
CHANGELOG.fr-FR.md docs(project): release/beta-1.0.36 (#1703) 2021-03-28 13:04:45 +08:00
CHANGELOG.jp.md docs(project): release/beta-1.0.36 (#1703) 2021-03-28 13:04:45 +08:00
CHANGELOG.zh-CN.md docs(project): release/beta-1.0.36 (#1703) 2021-03-28 13:04:45 +08:00
CODE_OF_CONDUCT.md
commitlint.config.js
jest.config.js
lerna.json
LICENSE
package.json workflow: Auto generate code hint files from the docs (#1749) 2021-04-06 11:41:02 +08:00
README.md
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