mirror/element-plus
2
0
Fork 0
mirror of https://github.com/element-plus/element-plus.git synced 2024-12-15 02:40:46 +08:00
Code Issues Packages Projects Releases Wiki Activity
349 Commits 87 Branches 205 Tags 781 MiB
TypeScript 51.3%
Vue 47.8%
JavaScript 0.6%
Shell 0.2%
c9d6aec329
Go to file
bastarder c9d6aec329
fix(element-plus): fix doc highlight bug (#365)
2020-09-28 16:09:10 +08:00
.github
build chore: update 2020-09-15 18:59:58 +08:00
packages feat(upload): upload component (#168) 2020-09-27 12:10:36 +08:00
public
scripts chore(core): deprecate storybook (#343) 2020-09-23 20:18:11 +08:00
types refactor(project): replace keyCode (#337) 2020-09-22 21:01:10 +08:00
typings feat: add jsx support for test case 2020-09-24 17:36:44 +08:00
website fix(element-plus): fix doc highlight bug (#365) 2020-09-28 16:09:10 +08:00
.editorconfig
.eslintrc.js feat(core): add jsx support 2020-09-15 13:53:41 +08:00
.gitattributes
.gitignore build: init build script 2020-09-15 18:59:58 +08:00
.npmrc
.prettierrc.js
CHANGELOG.en-US.md
CHANGELOG.es.md
CHANGELOG.fr-FR.md
CHANGELOG.zh-CN.md
CODE_OF_CONDUCT.md
commitlint.config.js
jest.config.js feat: add jsx support for test case 2020-09-24 17:36:44 +08:00
lerna.json fix: change the value of version from 'indenpendent' to 'independent' (#338) 2020-09-23 09:18:41 +08:00
LICENSE
package.json 1.0.1-alpha.3 2020-09-27 13:32:43 +08:00
README.md chore: chqnge it to the codesandbox icon 2020-09-28 10:15:46 +08:00
tsconfig.json feat(core): add jsx support 2020-09-15 13:53:41 +08:00
yarn.lock build: update website build 2020-09-24 20:00:48 +08:00

README.md

Element Plus - A Vue.js 3.0 UI library

  • 💪 Vue 3.0 Composition API
  • 🔥 Written in TypeScript

This project is still under heavy development. Feel free to join us and make your first pull request.

Edit element-plus

Join our Discord to start communicating with everybody Discord

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