About this project

Element Plus is a user interface component library for Vue 3, developed by the Element team. The README describes it as built on the Vue 3 Composition API and written in TypeScript, and it is published on npm under the name element-plus. The project states that its first stable release, suitable for production use, arrived on February 7, 2022, and that the API is stable as of that point. Getting started information is aimed at two audiences. Developers who want to build websites with the library are pointed to the official documentation site at element-plus.org, which also offers an accelerated mirror site for users in mainland China. People who want to improve the library itself are directed to the contribution material in the repository. Migration from Element UI is a documented concern. The README links to a breaking change list maintained in the repository's discussions, and to a separate gogocode migration tool intended to help move projects from Element UI to Element Plus. The project says this tool has been tested on Vue Element Admin, with the transpiled result published in a separate repository. For experimentation, the project offers an online playground at element-plus.run and a CodeSandbox template. Documentation translations are managed through Crowdin; the README notes that only English and Chinese documentation versions are currently provided because of limited resources, and invites volunteers to help translate or to apply as proofreaders. Community channels include a Discord server, and the repository points to CONTRIBUTING and Code of Conduct documents for participation details. The maintainers say they are looking for contributors, including people with expertise in testing, GitHub Actions and product management. The README also lists platinum and gold sponsors, thanks contributors and backers, and links to a contributors graph. The repository metadata shown in the README includes an npm registry version badge, a Node.js version requirement of 20 or higher, an npm download count badge, and a Codecov coverage badge. The README does not describe individual components, theming options, browser support or performance characteristics, so those details would need to come from the documentation site. Element Plus is released as open-source software under the MIT license.