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
172 Commits 94 Branches 203 Tags 758 MiB
TypeScript 50.7%
Vue 48.3%
JavaScript 0.6%
Shell 0.3%
c55dd7488c
Go to file
zazzaz c55dd7488c
Update README.md
2020-08-18 11:17:47 +08:00
.github ci: add lint to ci 2020-08-06 01:10:03 +08:00
.storybook feat(core): add avatar components 2020-08-03 15:00:05 +08:00
packages feat: add alert 2020-08-18 00:05:47 +08:00
public
scripts fix(project):fix gc.sh generating wrong format templates 2020-07-29 15:23:55 +08:00
src/style feat: add Layout component (#50) 2020-07-31 18:20:03 +08:00
typings feat(notification): add new component notification 2020-08-06 21:15:20 +08:00
website chore: update title 2020-08-14 09:54:27 +08:00
.editorconfig feat/add-storybook 2020-07-24 19:20:37 +08:00
.eslintrc.js Feat/checkbox (#131) 2020-08-13 15:16:38 +08:00
.gitignore feat: add website (#135) 2020-08-13 15:18:26 +08:00
.npmrc fix(dev): update cz & husky 2020-07-24 23:25:03 +08:00
CHANGELOG.en-US.md feat: add website (#135) 2020-08-13 15:18:26 +08:00
CHANGELOG.es.md feat: add website (#135) 2020-08-13 15:18:26 +08:00
CHANGELOG.fr-FR.md feat: add website (#135) 2020-08-13 15:18:26 +08:00
CHANGELOG.zh-CN.md feat: add website (#135) 2020-08-13 15:18:26 +08:00
commitlint.config.js chore/fix-linter-complains 2020-07-28 11:26:41 +08:00
jest.config.js fix: fix bundle issue 2020-08-14 09:54:27 +08:00
lerna.json feat: add lerna basic config 2020-07-22 00:35:23 +08:00
package.json fix: fix bundle issue 2020-08-14 09:54:27 +08:00
README.md Update README.md 2020-08-18 11:17:47 +08:00
tsconfig.json Update tsconfig.json 2020-08-10 12:58:04 +08:00
yarn.lock fix: revert yarn.lock 2020-08-18 00:05:47 +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.

Bootstrap project

With command

$ yarn bootstrap

the project will install all dependencies and run lerna bootstrap to initialize the project

Storybook preview

With command

$ yarn storybook

the project will launch @storybook client for you to preview all existing component

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