mirror/element-plus
2
0
Fork 0
mirror of https://github.com/element-plus/element-plus.git synced 2024-11-21 01:02:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
1,271 Commits 94 Branches 203 Tags 758 MiB
TypeScript 50.7%
Vue 48.3%
JavaScript 0.6%
Shell 0.3%
7d2263a99a
Go to file
jeremywu 7d2263a99a
chore: Update README.md (#2609) 
* Update README.md

* Update README.md
2021-07-22 14:31:19 +08:00
.github refactor(color): migrate color css var & simplify color box docs (#2589) 2021-07-20 22:58:06 +08:00
build chore: update search (#2390) 2021-06-30 15:07:26 +08:00
packages fix(style): ensure that the loading icon is inline (#2550) 2021-07-22 11:21:28 +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 docs(scrollbar): expose update function (#2607) 2021-07-22 11:18:34 +08:00
.editorconfig feat/add-storybook 2020-07-24 19:20:37 +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 chore: remove an repetitive file in .gitignore (#1673) 2021-03-22 09:09:14 +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 chore: update change log format (#2543) 2021-07-15 18:02:10 +08:00
CHANGELOG.es.md chore: update change log format (#2543) 2021-07-15 18:02:10 +08:00
CHANGELOG.fr-FR.md chore: update change log format (#2543) 2021-07-15 18:02:10 +08:00
CHANGELOG.jp.md chore: update change log format (#2543) 2021-07-15 18:02:10 +08:00
CHANGELOG.zh-CN.md chore: update change log format (#2543) 2021-07-15 18:02:10 +08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2020-08-19 10:19:38 +08:00
commitlint.config.js refactor(color): css var for border-color & simplify border-color docs (#2540) 2021-07-15 21:06:30 +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 feat(menu): improve handleItemClick (#2514) 2021-07-15 15:18:02 +08:00
README.md chore: Update README.md (#2609) 2021-07-22 14:31:19 +08:00
tsconfig.json fix(types): remove __test__ from ignore (#480) 2020-10-27 17:31:08 +08:00
yarn.lock chore: upgrade sass from 1.34.0 to 1.35.1 (#2437) 2021-07-05 09:05: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.

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.

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

  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

Licence

ElementPlus is open source software licensed as MIT.

Contributors

This project wouldn't exist without our amazing contributors