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,149 Commits 89 Branches 205 Tags 784 MiB
TypeScript 51.3%
Vue 47.8%
JavaScript 0.6%
Shell 0.2%
d17473867c
Go to file
Xing.Wu d17473867c
feat(docs): Progress code for composition (#2333) 
Co-authored-by: xing.wu <wuxing@bjca.org.cn>
2021-06-25 16:08:09 +08:00
.github Update master-deploy.yml 2021-06-03 14:50:20 +08:00
build Fix/revert changes for fixing issue (#2313) 2021-06-23 21:08:31 +08:00
packages fix(cascader-panel): should not re-init when props's value not change (#2344) 2021-06-25 16:08:00 +08:00
scripts fix(project): fix/upgrade-to-vue-3-1-1-and-with-bug-fix (#2220) 2021-06-11 18:20:49 +08:00
typings fix: Module @vue/test-utils has no exported members (#1139) 2020-12-31 10:42:38 +08:00
website feat(docs): Progress code for composition (#2333) 2021-06-25 16:08:09 +08:00
.editorconfig feat/add-storybook 2020-07-24 19:20:37 +08:00
.eslintrc.js feat(core): add jsx support 2020-09-15 13:53:41 +08:00
.gitattributes chore: update type 2020-08-28 14:54:23 +08:00
.gitignore chore: remove an repetitive file in .gitignore (#1673) 2021-03-22 09:09:14 +08:00
.prettierrc.js Feat/carousel (#151) 2020-09-15 10:50:32 +08:00
babel.config.js fix(build): fix utils esm build (#720) 2020-11-28 18:56:14 +08:00
CHANGELOG.en-US.md chore: update 52 cl (#2320) 2021-06-24 12:24:26 +08:00
CHANGELOG.es.md chore: update 52 cl (#2320) 2021-06-24 12:24:26 +08:00
CHANGELOG.fr-FR.md chore: update 52 cl (#2320) 2021-06-24 12:24:26 +08:00
CHANGELOG.jp.md chore: update 52 cl (#2320) 2021-06-24 12:24:26 +08:00
CHANGELOG.zh-CN.md chore: update 52 cl (#2320) 2021-06-24 12:24:26 +08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2020-08-19 10:19:38 +08:00
commitlint.config.js chore(project): modify some lint rules 2020-08-19 23:15:51 +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/table test (#2229) 2021-06-12 17:10:24 +08:00
README.md chore: update ad (#1968) 2021-05-09 01:03:27 +08:00
tsconfig.json fix(types): remove __test__ from ignore (#480) 2020-10-27 17:31:08 +08:00
yarn.lock Fix/table test (#2229) 2021-06-12 17:10:24 +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