About this project
Element is a UI component toolkit built for Vue.js 2.x web applications, published on npm as `element-ui`. According to the README, the project stays aligned with Vue 2.x; for Vue 3.0 the maintainers point users toward the separately developed Element Plus project, and for MiniProgram development they recommend MorJS.
Installation and usage
- Install with `npm install element-ui -S`.
- Register the whole library with `Vue.use(Element)`, or import individual components such as `Select` and `Button` and register them one by one with `Vue.component(...)`.
- A Quick Start guide is available in the documentation.
Documentation and links
- Official documentation is offered in several languages: English, Chinese, Spanish and French.
- Supporting resources listed in the README include an FAQ, a custom theme guide, an online theme preview and generator, and an `awesome-element` link collection.
- Starter kits are listed for plain Element projects and for Laravel, and design resources are available in a separate repository.
- Editor helpers exist for Atom and Visual Studio Code.
- Ports of the same component approach exist for React and Angular.
- Community chat takes place on Gitter, with separate rooms for international and Chinese users, and there is also a Dingtalk discussion group.
Compatibility
The README states support for modern browsers and Internet Explorer 10 and above.
Theming
Customization of the theme is documented, and an online tool is provided to preview and generate themes.
Contributing
A contributing guide is available in Chinese, English, Spanish and French, and covers how to run the project. Release-by-release changes are recorded in the repository's release notes, and the FAQ is suggested as a first place to search before reporting an issue.
The English, Spanish and French documentation is credited to community translators and developers named in the README.
License
MIT.
Who it may suit
Teams building Vue 2 based web interfaces that need a ready-made set of components, on-demand imports, theme customization and documentation in multiple languages. Projects already on Vue 3 should look at the recommended successor project instead.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.