快速上手

本节将介绍如何在项目中使用 Element。

使用 vue-cli@3

我们为新版的 vue-cli 准备了相应的 Element 插件，你可以用它们快速地搭建一个基于 Element 的项目。

使用 Starter Kit

我们提供了通用的项目模板，你可以直接使用。对于 Laravel 用户，我们也准备了相应的模板，同样可以直接下载使用。

如果不希望使用我们提供的模板，请继续阅读。

引入 Element

你可以引入整个 Element，或是根据需要仅引入部分组件。我们先介绍如何引入完整的 Element。

完整引入

在 main.js 中写入以下内容：

  1. import Vue from 'vue';
  2. import ElementUI from 'element-ui';
  3. import 'element-ui/lib/theme-chalk/index.css';
  4. import App from './App.vue';
  6. Vue.use(ElementUI);
  8. new Vue({
  9.   el: '#app',
  10.   render: h => h(App)
  11. });

以上代码便完成了 Element 的引入。需要注意的是，样式文件需要单独引入。

按需引入

借助 babel-plugin-component，我们可以只引入需要的组件，以达到减小项目体积的目的。

首先，安装 babel-plugin-component：

  1. npm install babel-plugin-component -D

然后，将 .babelrc 修改为：

  1. {
  2.   "presets": [["es2015", { "modules": false }]],
  3.   "plugins": [
  4.     [
  5.       "component",
  6.       {
  7.         "libraryName": "element-ui",
  8.         "styleLibraryName": "theme-chalk"
  9.       }
  10.     ]
  11.   ]
  12. }

接下来，如果你只希望引入部分组件，比如 Button 和 Select，那么需要在 main.js 中写入以下内容：

  1. import Vue from 'vue';
  2. import { Button, Select } from 'element-ui';
  3. import App from './App.vue';
  5. Vue.component(Button.name, Button);
  6. Vue.component(Select.name, Select);
  7. /* 或写为
  8.  * Vue.use(Button)
  9.  * Vue.use(Select)
  10.  */
  12. new Vue({
  13.   el: '#app',
  14.   render: h => h(App)
  15. });

完整组件列表和引入方式（完整组件列表以 components.json 为准）

  1. import Vue from 'vue';
  2. import {
  3.   Pagination,
  4.   Dialog,
  5.   Autocomplete,
  6.   Dropdown,
  7.   DropdownMenu,
  8.   DropdownItem,
  9.   Menu,
  10.   Submenu,
  11.   MenuItem,
  12.   MenuItemGroup,
  13.   Input,
  14.   InputNumber,
  15.   Radio,
  16.   RadioGroup,
  17.   RadioButton,
  18.   Checkbox,
  19.   CheckboxButton,
  20.   CheckboxGroup,
  21.   Switch,
  22.   Select,
  23.   Option,
  24.   OptionGroup,
  25.   Button,
  26.   ButtonGroup,
  27.   Table,
  28.   TableColumn,
  29.   DatePicker,
  30.   TimeSelect,
  31.   TimePicker,
  32.   Popover,
  33.   Tooltip,
  34.   Breadcrumb,
  35.   BreadcrumbItem,
  36.   Form,
  37.   FormItem,
  38.   Tabs,
  39.   TabPane,
  40.   Tag,
  41.   Tree,
  42.   Alert,
  43.   Slider,
  44.   Icon,
  45.   Row,
  46.   Col,
  47.   Upload,
  48.   Progress,
  49.   Badge,
  50.   Card,
  51.   Rate,
  52.   Steps,
  53.   Step,
  54.   Carousel,
  55.   CarouselItem,
  56.   Collapse,
  57.   CollapseItem,
  58.   Cascader,
  59.   ColorPicker,
  60.   Transfer,
  61.   Container,
  62.   Header,
  63.   Aside,
  64.   Main,
  65.   Footer,
  66.   Loading,
  67.   MessageBox,
  68.   Message,
  69.   Notification
  70. } from 'element-ui';
  72. Vue.use(Pagination);
  73. Vue.use(Dialog);
  74. Vue.use(Autocomplete);
  75. Vue.use(Dropdown);
  76. Vue.use(DropdownMenu);
  77. Vue.use(DropdownItem);
  78. Vue.use(Menu);
  79. Vue.use(Submenu);
  80. Vue.use(MenuItem);
  81. Vue.use(MenuItemGroup);
  82. Vue.use(Input);
  83. Vue.use(InputNumber);
  84. Vue.use(Radio);
  85. Vue.use(RadioGroup);
  86. Vue.use(RadioButton);
  87. Vue.use(Checkbox);
  88. Vue.use(CheckboxButton);
  89. Vue.use(CheckboxGroup);
  90. Vue.use(Switch);
  91. Vue.use(Select);
  92. Vue.use(Option);
  93. Vue.use(OptionGroup);
  94. Vue.use(Button);
  95. Vue.use(ButtonGroup);
  96. Vue.use(Table);
  97. Vue.use(TableColumn);
  98. Vue.use(DatePicker);
  99. Vue.use(TimeSelect);
  100. Vue.use(TimePicker);
  101. Vue.use(Popover);
  102. Vue.use(Tooltip);
  103. Vue.use(Breadcrumb);
  104. Vue.use(BreadcrumbItem);
  105. Vue.use(Form);
  106. Vue.use(FormItem);
  107. Vue.use(Tabs);
  108. Vue.use(TabPane);
  109. Vue.use(Tag);
  110. Vue.use(Tree);
  111. Vue.use(Alert);
  112. Vue.use(Slider);
  113. Vue.use(Icon);
  114. Vue.use(Row);
  115. Vue.use(Col);
  116. Vue.use(Upload);
  117. Vue.use(Progress);
  118. Vue.use(Badge);
  119. Vue.use(Card);
  120. Vue.use(Rate);
  121. Vue.use(Steps);
  122. Vue.use(Step);
  123. Vue.use(Carousel);
  124. Vue.use(CarouselItem);
  125. Vue.use(Collapse);
  126. Vue.use(CollapseItem);
  127. Vue.use(Cascader);
  128. Vue.use(ColorPicker);
  129. Vue.use(Transfer);
  130. Vue.use(Container);
  131. Vue.use(Header);
  132. Vue.use(Aside);
  133. Vue.use(Main);
  134. Vue.use(Footer);
  136. Vue.use(Loading.directive);
  138. Vue.prototype.$loading = Loading.service;
  139. Vue.prototype.$msgbox = MessageBox;
  140. Vue.prototype.$alert = MessageBox.alert;
  141. Vue.prototype.$confirm = MessageBox.confirm;
  142. Vue.prototype.$prompt = MessageBox.prompt;
  143. Vue.prototype.$notify = Notification;
  144. Vue.prototype.$message = Message;

全局配置

在引入 Element 时，可以传入一个全局配置对象。该对象目前支持 size 与 zIndex 字段。size 用于改变组件的默认尺寸，zIndex 设置弹框的初始 z-index（默认值：2000）。按照引入 Element 的方式，具体操作如下：

完整引入 Element：

  1. import Vue from 'vue';
  2. import Element from 'element-ui';
  3. Vue.use(Element, { size: 'small', zIndex: 3000 });

按需引入 Element：

  1. import Vue from 'vue';
  2. import { Button } from 'element-ui';
  4. Vue.prototype.$ELEMENT = { size: 'small', zIndex: 3000 };
  5. Vue.use(Button);

按照以上设置，项目中所有拥有 size 属性的组件的默认尺寸均为 'small'，弹框的初始 z-index 为 3000。

开始使用

至此，一个基于 Vue 和 Element 的开发环境已经搭建完毕，现在就可以编写代码了。各个组件的使用方法请参阅它们各自的文档。

使用 Nuxt.js

我们还可以使用 Nuxt.js：