element README

The project's README from github.com/ElemeFE/element. As one markdown file: README.md.


A Vue.js 2.0 UI Toolkit for Web.

Element will stay with Vue 2.x

For Vue 3.0, we recommend using Element Plus(Element Plus is a community develop project)

For MiniProgram development, we recommend using MorJS

Install

npm install element-ui -S

Quick Start

import Vue from 'vue'
import Element from 'element-ui'

Vue.use(Element)

// or
import {
  Select,
  Button
  // ...
} from 'element-ui'

Vue.component(Select.name, Select)
Vue.component(Button.name, Button)

For more information, please refer to Quick Start in our documentation.

Browser Support

Modern browsers and Internet Explorer 10+.

Development

Skip this part if you just want to use Element.

For those who are interested in contributing to Element, please refer to our contributing guide (中文 | English | Español | Français) to see how to run this project.

Changelog

Detailed changes for each release are documented in the release notes.

FAQ

We have collected some frequently asked questions. Before reporting an issue, please search if the FAQ has the answer to your problem.

Contribution

Please make sure to read the contributing guide (中文 | English | Español | Français) before making a pull request.

Special Thanks

English documentation is brought to you by SwiftGG Translation Team:

Spanish documentation is made possible by these community developers:

French documentation is made possible by these community developers:

Join Discussion Group

Scan the QR code using Dingtalk App to join in discussion group :

Join Discusion Group

LICENSE

MIT

element (ElemeFE/element)

Searching Database…

54K ·GitHub
Element
What is this?Element is a Vue.js 2.0 UI toolkit: a library of ready-made interface components you use to build web interfaces.
How do I add Element to my Vue app?Install it from npm as the element-ui package and wire it into your Vue 2 entry file; the Quick Start section of the docs walks through the exact steps.
Does installing it pull in a pile of dependencies?No — its package.json lists only six small runtime helpers, such as async-validator, deepmerge and normalize-wheel; npm installs them alongside the package.
My project is on Vue 3 — can I still use it?No: Element stays on Vue 2.x. For Vue 3 the README points you to Element Plus, a community project, and it recommends MorJS for MiniProgram development.
Is it built for a Chinese audience or an international one?International: the README has dedicated docs for Chinese, Spanish and French users alongside the English ones.
Which browsers does it support?Per the README: modern browsers plus Internet Explorer 10+.
Can I theme it to match my brand?Yes — there is a theme customization guide, plus an online tool to preview and generate a custom theme before using it.
Is there a starter template for a new project?Two are linked in the README: element-starter for a plain Vue setup and element-in-laravel-starter for Laravel apps.
I use React or Angular — is there an equivalent?The README links sibling ports: Element for React and Element for Angular.
What are similar projects?mint-ui, element-plus, vuetify, vux, iview, vuestic-admin, vant, naive-ui
Which topics is it in?vue-components, element-ui, starter-kit, vue2, ui-kit, laravel, vuejs, toolkit, components, design-system, theme, component-library
Creator
ElemeFE
Size
91.2 MB
Stars
54K
Updated
CommitApr 02Releasev2.15.14Aug 24
Age
10y
Commits · 90 Days