Go to file
renovate[bot] 3504d104e8
chore(deps): update pnpm to v6.24.1 (#4832)
Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-12-16 19:31:41 +08:00
.github chore: update issue workflow (#4794) 2021-12-12 23:31:02 +08:00
.husky chore(project): use pretty-quick (#3755) 2021-10-01 14:17:16 +08:00
.vscode chore(dev): add i18n-ally vscode config (#4160) 2021-11-03 15:45:41 +08:00
build fix(build): copy README (#4782) 2021-12-10 23:48:21 +08:00
docs refactor(docs): use setup sugar simplify input demo (#4845) 2021-12-15 17:32:09 +08:00
packages chore: move \@ctrl/tinycolor to dependencies (#4842) 2021-12-15 23:15:19 +08:00
play chore(deps): update dependency vite to v2.7.2 (#4811) 2021-12-14 00:48:26 +08:00
scripts fix(build): copy README (#4782) 2021-12-10 23:48:21 +08:00
typings build: refactor copyDefinitions (#3756) 2021-10-06 19:40:44 +08:00
.editorconfig
.eslintignore chore: ignore CHANGELOG lint (#3762) 2021-10-07 11:57:16 +08:00
.eslintrc.js chore(deps): update dependency eslint-plugin-vue to v8 (#4105) 2021-10-30 18:13:00 +08:00
.gitattributes chore(project): improve prettier format (#3236) 2021-09-05 00:53:31 +08:00
.gitignore build: refactor each package build (#3709) 2021-09-28 20:28:47 +08:00
.markdownlint.json feat(components): add virtual tree (#3398) 2021-09-27 11:12:50 +08:00
.npmrc refactor(style): adjust component size to large/default/small (#4491) 2021-12-12 17:54:21 +08:00
.nvmrc refactor: replace yarn with pnpm (#3571) 2021-09-23 08:12:37 +08:00
.prettierignore chore: ignore CHANGELOG lint (#3762) 2021-10-07 11:57:16 +08:00
.prettierrc chore(project): improve prettier format (#3236) 2021-09-05 00:53:31 +08:00
CHANGELOG.en-US.md chore: Update changelog 1.2.0-beta.6 (#4775) 2021-12-10 18:52:21 +08:00
CODE_OF_CONDUCT.md
commitlint.config.js refactor: replace yarn with pnpm (#3571) 2021-09-23 08:12:37 +08:00
DEV_FAQ.md fix(style): remove chinese comments in checkbox (#4189) 2021-11-04 10:04:38 +08:00
jest.config.js test: upgrade @vue/test-utils to v2.0.0-rc.15 2021-10-06 17:19:00 +08:00
jest.setup.js refactor(components): refactor tabs 2021-11-12 05:43:40 +08:00
LICENSE
package.json chore(deps): update pnpm to v6.24.1 (#4832) 2021-12-16 19:31:41 +08:00
pnpm-lock.yaml chore: move \@ctrl/tinycolor to dependencies (#4842) 2021-12-15 23:15:19 +08:00
pnpm-workspace.yaml refactor: replace yarn with pnpm (#3571) 2021-09-23 08:12:37 +08:00
README.md chore: update readme 2021-12-11 13:16:25 +08:00
renovate.json5 fix(build): fix types (#4254) 2021-11-05 22:47:03 -04:00
tsconfig.json fix(build): compatible to build on windows (#4747) 2021-12-10 18:18:16 +08:00


Element Plus - A Vue.js 3 UI library

  • 💪 Vue 3 Composition API
  • 🔥 Written in TypeScript

Archived website

If you are looking for previous version website, here is the link.

Element Plus Documentation Archived

The new website is launched at 17th Sep 2021.

Status: Beta

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

Playground

Try it with code sandbox

Edit element-plus

Try it with our built-in playground

Playground

Special thanks to the generous sponsorship by:



Translations

Element Plus is translated to multiple languages, you can click the badge to help up update the translation or apply to become a proofreader Crowdin

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

$ pnpm i

the project will install all dependencies

Website preview

With command

$ pnpm docs:dev

the project will launch website for you to preview all existing component

Local development

  1. With command
$ pnpm dev

will start the local development environment

  1. Add your component into play/src/App.vue

App.vue

<template>
  <ComponentYouAreDeveloping />
</template>

<script setup lang="ts">
// make sure this component is registered in @element-plus/components
import { ComponentYouAreDeveloping } from '@element-plus/components'
</script>

Modify App.vue file per your needs to get things work.

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

$ pnpm gen component-name

Note the component-name must be in kebab-case, combining words by replacing each space with a dash.

And component type must be added to typings/global.d.ts.

Commit template

With command

pnpm cz

Example

# [TYPE](SCOPE): [el-component-name] DESCRIPTION#[ISSUE]
# example: feat(components): [el-button] add type for form usage #1234

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor

Contributors

This project exists thanks to all the people who contribute.

And thank you to all our backers! 🙏

Licence

Element Plus is open source software licensed as MIT.