mirror of
https://github.com/element-plus/element-plus.git
synced 2024-12-27 03:01:14 +08:00
152 lines
6.8 KiB
Markdown
152 lines
6.8 KiB
Markdown
<p align="center">
|
|
<img width="300px" src="https://user-images.githubusercontent.com/10731096/95823103-9ce15780-0d5f-11eb-8010-1bd1b5910d4f.png">
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://www.npmjs.org/package/element-plus">
|
|
<img src="https://img.shields.io/npm/v/element-plus.svg">
|
|
</a>
|
|
<a href="https://npmcharts.com/compare/element-plus?minimal=true">
|
|
<img src="https://img.shields.io/npm/dm/element-plus.svg">
|
|
</a>
|
|
<a href="https://codecov.io/gh/element-plus/element-plus">
|
|
<img src="https://codecov.io/gh/element-plus/element-plus/branch/dev/graph/badge.svg?token=BKSBO2GLZI"/>
|
|
</a>
|
|
<br>
|
|
</p>
|
|
|
|
<p align="center">Element Plus - A Vue.js 3 UI library</p>
|
|
|
|
- 💪 Vue 3 Composition API
|
|
- 🔥 Written in TypeScript
|
|
|
|
## Getting Started
|
|
|
|
Alright, for you to get started if you are looking for making Element Plus better you should keep reading.
|
|
For developers that uses Element Plus to develop your website you should go ahead visit [Getting Started](https://element-plus.org/).
|
|
|
|
- 中国大陆[加速镜像站点](https://element-plus.gitee.io/)
|
|
|
|
## Breaking change list
|
|
|
|
The first stable release of Element Plus suitable for use in production was released on February 07, 2022. The APIs is stable right now, and here's also a full list about how to get upgraded from [Element UI](https://element.eleme.io) to Element Plus.
|
|
|
|
You can find the breaking change list here: [Breaking Change List](https://github.com/element-plus/element-plus/discussions/5658).
|
|
|
|
### Migration Tool :hammer_and_wrench:
|
|
|
|
We have made a migration tool for you to migrate your project from [Element UI](https://element.eleme.io) to Element Plus.
|
|
|
|
You can find the [gogo code migration tool](https://github.com/thx/gogocode/tree/main/packages/gogocode-plugin-element) here.
|
|
|
|
We have tested this on [Vue Element Admin](https://github.com/PanJiaChen/vue-element-admin). You can find the transpiled code [here](https://github.com/gogocodeio/vue-element-admin).
|
|
|
|
### Playground
|
|
|
|
You can also try Element Plus out with the components built-in playground.
|
|
|
|
#### Try it with our built-in playground
|
|
|
|
[Playground](https://element-plus.run/)
|
|
|
|
#### Try it with code sandbox
|
|
|
|
[](https://codesandbox.io/s/element-plus-demo-dxtcr)
|
|
|
|
<p align="center">
|
|
<b>Special thanks to the generous sponsorship by:</b>
|
|
</p>
|
|
<br/>
|
|
<table align="center" cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr>
|
|
<td align="center" valign="middle">
|
|
<a href="https://vform666.com/vform3.html?from=element_plus" target="_blank">
|
|
<img width="150px" src="https://user-images.githubusercontent.com/17680888/156870588-b25a42d5-888b-4943-8b1b-5239dfd8f4d2.png">
|
|
</a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://js.design?source=element-plus" target="_blank">
|
|
<img width="150px" src="https://user-images.githubusercontent.com/17680888/160634485-df0d00af-8633-4ab8-9a72-aac2b65d1d36.png">
|
|
</a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://fantastic-admin.netlify.app/?from=element-plus" target="_blank">
|
|
<img width="150px" src="https://user-images.githubusercontent.com/82012629/167299102-e2e66150-2248-4f03-bbf2-84c622e7d165.png">
|
|
</a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://bit.dev/?from=element-ui" target="_blank">
|
|
<img width="150px" src="https://user-images.githubusercontent.com/10095631/41342907-e44e7196-6f2f-11e8-92f2-47702dc8f059.png">
|
|
</a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://www.renren.io/?from=element-ui" target="_blank">
|
|
<img width="150px" src="https://user-images.githubusercontent.com/82012629/126620778-0d8ab509-018a-45d7-b8de-a5bac2ad519a.png">
|
|
</a>
|
|
</td>
|
|
<td align="center" valign="middle">
|
|
<a href="https://form.making.link/?from=element_plus" target="_blank">
|
|
<img width="150px" src="https://user-images.githubusercontent.com/17680888/159736613-13c7c2dc-744e-4eec-b801-f4ca57871787.png">
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
---
|
|
|
|
## 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 [](https://crowdin.com/project/element-plus)
|
|
|
|
For now we are only showing English and Chinese for resource reasons, but we are looking forward to translate it into more languages, please go to the link
|
|
above and leave a message if you want to help translating Element Plus into your desired language.
|
|
|
|
### How to help translating
|
|
|
|
See how to help translating in [Translating Element Plus](./HELP_TRANSLATING.md).
|
|
|
|
## Stay tuned :eyes:
|
|
|
|
Join our [Discord](https://discord.link/ElementPlus) to start communicating with everybody.
|
|
|
|
## This thing is broken, I should help improve it!
|
|
|
|
Awesommmmmmee. Everything you need is down below. You can also refer to
|
|
[CONTRIBUTING](https://github.com/element-plus/element-plus/blob/dev/CONTRIBUTING.md) and
|
|
[Code of Conduct](https://github.com/element-plus/element-plus/blob/dev/CODE_OF_CONDUCT.md)
|
|
where you'll find the same information listed below.
|
|
|
|
## I would like to become a part of the development team!
|
|
|
|
Welcome :star_struck:! We are looking for talented developers to join us and making Element Plus better! If you care to join the development team, please
|
|
reach out to us, you are more than welcomed to join us! :heart:
|
|
|
|
We are now lacking of experts of `Testing`, `GitHub Actions`, `PM`, if you do feel like you can and willing to help us, please do reach out to us. :pray:
|
|
|
|
## Sponsors
|
|
|
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor](https://opencollective.com/element-plus#sponsor)
|
|
|
|
<a href="https://opencollective.com/element-plus/sponsor/0/website" target="_blank"><img src="https://opencollective.com/element-plus/sponsor/0/avatar.svg"></a>
|
|
<a href="https://opencollective.com/element-plus/sponsor/1/website" target="_blank"><img src="https://opencollective.com/element-plus/sponsor/1/avatar.svg"></a>
|
|
<a href="https://opencollective.com/element-plus/sponsor/2/website" target="_blank"><img src="https://opencollective.com/element-plus/sponsor/2/avatar.svg"></a>
|
|
<a href="https://opencollective.com/element-plus/sponsor/3/website" target="_blank"><img src="https://opencollective.com/element-plus/sponsor/3/avatar.svg"></a>
|
|
|
|
## Contributors
|
|
|
|
This project exists thanks to all the people who contribute.
|
|
|
|
And thank you to all our backers! 🙏
|
|
|
|
<a href="https://github.com/element-plus/element-plus/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=element-plus/element-plus" />
|
|
</a>
|
|
|
|
## License
|
|
|
|
Element Plus is open source software licensed as
|
|
[MIT](https://github.com/element-plus/element-plus/blob/master/LICENSE).
|