81e6c377ba
* fix: provide root locale * refactor(locale): refactor locale * fix: tests * revert: play |
||
|---|---|---|
| .github | ||
| .husky | ||
| .vscode | ||
| build | ||
| docs | ||
| packages | ||
| play | ||
| scripts | ||
| typings | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| .markdownlint.json | ||
| .npmrc | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| CHANGELOG.en-US.md | ||
| CODE_OF_CONDUCT.md | ||
| commitlint.config.js | ||
| DEV_FAQ.md | ||
| jest.config.js | ||
| jest.setup.js | ||
| LICENSE | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| README.md | ||
| renovate.json5 | ||
| tsconfig.json | ||
Element Plus - A Vue.js 3 UI library
- 💪 Vue 3 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.
Playground
Try it with code sandbox
Try it with our built-in 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 
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
- With command
$ pnpm dev
will start the local development environment
- 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
- Convert the item in https://github.com/element-plus/element-plus/projects/1 to an issue
- Assign yourself to the issue
- Author your component by generating new component command below
- Migrate tests and docs
- 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.