2016-08-30 19:30:58 +08:00
|
|
|
|
## 快速上手
|
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
本节将介绍如何在项目中使用 Element。
|
2016-07-27 14:15:02 +08:00
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
### 使用 Starter Kit
|
2016-08-30 19:30:58 +08:00
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
我们提供了通用的[项目模板](https://github.com/ElementUI/element-starter),你可以直接使用。对于熟悉 [cooking](https://github.com/ElementUI/element-cooking-starter) 或 [Laravel](https://github.com/ElementUI/element-in-laravel-starter) 的用户,我们也准备了相应的模板,同样可以直接下载使用。
|
2016-08-30 19:30:58 +08:00
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
如果不希望使用我们提供的模板,请继续阅读。
|
2016-08-30 19:30:58 +08:00
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
### 配置文件
|
2016-08-30 19:30:58 +08:00
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
新建项目,项目结构为
|
|
|
|
|
```text
|
|
|
|
|
|- src/ --------------------- 项目源代码
|
2016-10-28 21:35:05 +08:00
|
|
|
|
|- App.vue
|
2016-10-28 15:31:19 +08:00
|
|
|
|
|- main.js -------------- 入口文件
|
|
|
|
|
|- .babelrc ----------------- babel 配置文件
|
|
|
|
|
|- index.html --------------- HTML 模板
|
|
|
|
|
|- package.json ------------- npm 配置文件
|
|
|
|
|
|- README.md ---------------- 项目帮助文档
|
2016-11-13 22:00:55 +08:00
|
|
|
|
|- webpack.config.js ------ webpack 配置文件
|
2016-10-28 15:31:19 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
几个配置文件的典型配置如下:
|
2016-08-30 19:30:58 +08:00
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
**.babelrc**
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"presets": [
|
|
|
|
|
["es2015", { "modules": false }]
|
|
|
|
|
]
|
|
|
|
|
}
|
2016-08-30 19:30:58 +08:00
|
|
|
|
```
|
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
**package.json**
|
|
|
|
|
```json
|
|
|
|
|
{
|
2016-11-16 11:03:28 +08:00
|
|
|
|
"name": "element-starter",
|
2016-10-28 15:31:19 +08:00
|
|
|
|
"scripts": {
|
|
|
|
|
"dev": "cross-env NODE_ENV=development webpack-dev-server --inline --hot --port 8086",
|
|
|
|
|
"build": "cross-env NODE_ENV=production webpack --progress --hide-modules"
|
|
|
|
|
},
|
|
|
|
|
"dependencies": {
|
2016-11-09 17:36:17 +08:00
|
|
|
|
"element-ui": "^1.0.0",
|
|
|
|
|
"vue": "^2.0.5"
|
2016-10-28 15:31:19 +08:00
|
|
|
|
},
|
|
|
|
|
"devDependencies": {
|
|
|
|
|
"babel-core": "^6.0.0",
|
|
|
|
|
"babel-loader": "^6.0.0",
|
|
|
|
|
"babel-preset-es2015": "^6.13.2",
|
|
|
|
|
"cross-env": "^1.0.6",
|
|
|
|
|
"css-loader": "^0.23.1",
|
|
|
|
|
"file-loader": "^0.8.5",
|
|
|
|
|
"style-loader": "^0.13.1",
|
2016-11-16 11:03:28 +08:00
|
|
|
|
"vue-loader": "^9.8.0",
|
|
|
|
|
"webpack": "beta",
|
|
|
|
|
"webpack-dev-server": "beta"
|
2016-10-28 15:31:19 +08:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
2016-08-30 19:30:58 +08:00
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
<br>
|
2016-08-30 19:30:58 +08:00
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
**webpack.config.js**
|
2016-08-30 19:30:58 +08:00
|
|
|
|
```javascript
|
2016-10-28 15:31:19 +08:00
|
|
|
|
var path = require('path')
|
|
|
|
|
var webpack = require('webpack')
|
|
|
|
|
|
|
|
|
|
module.exports = {
|
|
|
|
|
entry: './src/main.js',
|
|
|
|
|
output: {
|
|
|
|
|
path: path.resolve(__dirname, './dist'),
|
|
|
|
|
publicPath: '/dist/',
|
|
|
|
|
filename: 'build.js'
|
|
|
|
|
},
|
|
|
|
|
module: {
|
|
|
|
|
loaders: [
|
|
|
|
|
{
|
|
|
|
|
test: /\.vue$/,
|
2016-11-16 11:03:28 +08:00
|
|
|
|
loader: 'vue-loader'
|
2016-10-28 15:31:19 +08:00
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
test: /\.js$/,
|
2016-11-16 11:03:28 +08:00
|
|
|
|
loader: 'babel-loader',
|
2016-10-28 15:31:19 +08:00
|
|
|
|
exclude: /node_modules/
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
test: /\.css$/,
|
2016-11-16 11:03:28 +08:00
|
|
|
|
loader: 'style-loader!css-loader'
|
2016-10-28 15:31:19 +08:00
|
|
|
|
},
|
|
|
|
|
{
|
2016-11-16 11:03:28 +08:00
|
|
|
|
test: /\.(eot|svg|ttf|woff|woff2)(\?\S*)?$/,
|
|
|
|
|
loader: 'file-loader'
|
2016-10-28 15:31:19 +08:00
|
|
|
|
},
|
|
|
|
|
{
|
2016-11-16 11:03:28 +08:00
|
|
|
|
test: /\.(png|jpe?g|gif|svg)(\?\S*)?$/,
|
|
|
|
|
loader: 'file-loader',
|
2016-10-28 15:31:19 +08:00
|
|
|
|
query: {
|
|
|
|
|
name: '[name].[ext]?[hash]'
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
devServer: {
|
|
|
|
|
historyApiFallback: true,
|
|
|
|
|
noInfo: true
|
|
|
|
|
},
|
|
|
|
|
devtool: '#eval-source-map'
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (process.env.NODE_ENV === 'production') {
|
|
|
|
|
module.exports.devtool = '#source-map'
|
|
|
|
|
// http://vue-loader.vuejs.org/en/workflow/production.html
|
|
|
|
|
module.exports.plugins = (module.exports.plugins || []).concat([
|
|
|
|
|
new webpack.DefinePlugin({
|
|
|
|
|
'process.env': {
|
|
|
|
|
NODE_ENV: '"production"'
|
|
|
|
|
}
|
|
|
|
|
}),
|
|
|
|
|
new webpack.optimize.UglifyJsPlugin({
|
|
|
|
|
compress: {
|
|
|
|
|
warnings: false
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
])
|
|
|
|
|
}
|
2016-08-30 19:30:58 +08:00
|
|
|
|
```
|
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
### 引入 Element
|
|
|
|
|
|
|
|
|
|
你可以引入整个 Element,或是根据需要仅引入部分组件。我们先介绍如何引入完整的 Element。
|
2016-08-30 19:30:58 +08:00
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
#### 完整引入
|
|
|
|
|
|
|
|
|
|
在 main.js 中写入以下内容:
|
2016-08-30 19:30:58 +08:00
|
|
|
|
```javascript
|
2016-10-28 15:31:19 +08:00
|
|
|
|
import Vue from 'vue'
|
|
|
|
|
import ElementUI from 'element-ui'
|
|
|
|
|
import 'element-ui/lib/theme-default/index.css'
|
|
|
|
|
import App from './App.vue'
|
|
|
|
|
|
|
|
|
|
Vue.use(ElementUI)
|
2016-08-30 19:30:58 +08:00
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
new Vue({
|
|
|
|
|
el: '#app',
|
|
|
|
|
render: h => h(App)
|
|
|
|
|
})
|
2016-08-30 19:30:58 +08:00
|
|
|
|
```
|
2016-10-28 15:31:19 +08:00
|
|
|
|
以上代码便完成了 Element 的引入。需要注意的是,样式文件需要单独引入。
|
2016-08-30 19:30:58 +08:00
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
#### 按需引入
|
2016-07-27 14:15:02 +08:00
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
借助 [babel-plugin-component](https://github.com/QingWei-Li/babel-plugin-component),我们可以只引入需要的组件,以达到减小项目体积的目的。
|
2016-07-27 14:15:02 +08:00
|
|
|
|
|
2016-10-28 15:31:19 +08:00
|
|
|
|
首先,安装 babel-plugin-component:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
npm install babel-plugin-component -D
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
然后,将 .babelrc 修改为:
|
2016-08-30 19:30:58 +08:00
|
|
|
|
```json
|
|
|
|
|
{
|
2016-10-28 15:31:19 +08:00
|
|
|
|
"presets": [
|
|
|
|
|
["es2015", { "modules": false }]
|
|
|
|
|
],
|
|
|
|
|
"plugins": [["component", [
|
2016-08-30 19:30:58 +08:00
|
|
|
|
{
|
|
|
|
|
"libraryName": "element-ui",
|
|
|
|
|
"styleLibraryName": "theme-default"
|
|
|
|
|
}
|
|
|
|
|
]]]
|
|
|
|
|
}
|
|
|
|
|
```
|
2016-09-23 08:27:29 +08:00
|
|
|
|
|
2016-11-13 11:58:45 +08:00
|
|
|
|
接下来,如果你只希望引入部分组件,比如 Button 和 Select,那么需要在 main.js 中写入以下内容:
|
2016-10-28 15:31:19 +08:00
|
|
|
|
|
|
|
|
|
```javascript
|
|
|
|
|
import Vue from 'vue'
|
|
|
|
|
import { Button, Select } from 'element-ui'
|
|
|
|
|
import App from './App.vue'
|
|
|
|
|
|
|
|
|
|
Vue.component(Button.name, Button)
|
|
|
|
|
Vue.component(Select.name, Select)
|
|
|
|
|
/* 或写为
|
|
|
|
|
* Vue.use(Button)
|
|
|
|
|
* Vue.use(Select)
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
new Vue({
|
|
|
|
|
el: '#app',
|
|
|
|
|
render: h => h(App)
|
|
|
|
|
})
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### 开始使用
|
|
|
|
|
|
|
|
|
|
至此,一个基于 Vue 和 Element 的开发环境已经搭建完毕,现在就可以编写代码了。启动开发模式:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# 执行如下命令后访问 localhost:8086
|
|
|
|
|
npm run dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
编译:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
npm run build
|
2016-09-23 08:27:29 +08:00
|
|
|
|
```
|
2016-10-28 15:31:19 +08:00
|
|
|
|
各个组件的使用方法请参阅它们各自的文档。
|