ant-design-vue/docs/vue/use-with-vue-cli.zh-CN.md

156 lines
4.2 KiB
Markdown
Raw Normal View History

2018-04-09 22:49:58 +08:00
2018-04-10 12:08:41 +08:00
# 在 vue-cli 中使用
2018-04-09 22:49:58 +08:00
2018-04-10 12:08:41 +08:00
[vue-cli](https://github.com/vuejs/vue-cli) 是业界最优秀的 Vue 应用开发工具之一,本文会尝试在 vue-cli 创建的工程中使用 antd 组件,并自定义 webpack 的配置以满足各类工程化需求。
2018-04-09 22:49:58 +08:00
## 安装和初始化
2018-04-10 12:08:41 +08:00
我们需要在命令行中安装 vue-cli 工具,你可能还需要安装 [yarn](https://github.com/yarnpkg/yarn/)。
2018-04-09 22:49:58 +08:00
```bash
2018-04-10 12:08:41 +08:00
$ npm install -g vue-cli yarn
2018-04-09 22:49:58 +08:00
```
然后新建一个项目。
```bash
2018-04-10 12:08:41 +08:00
$ vue init webpack antd-demo
2018-04-09 22:49:58 +08:00
```
2018-04-10 12:08:41 +08:00
工具会自动初始化一个脚手架并安装 Vue 项目的各种必要依赖,如果在过程中出现网络问题,请尝试配置代理或使用其他 npm registry。
2018-04-09 22:49:58 +08:00
然后我们进入项目并启动。
```bash
$ cd antd-demo
2018-04-10 12:08:41 +08:00
$ npm run dev
2018-04-09 22:49:58 +08:00
```
2018-04-10 12:08:41 +08:00
此时浏览器会访问 http://localhost:8080/ ,看到 `Welcome to Your Vue.js App` 的界面就算成功了。
2018-04-09 22:49:58 +08:00
## 引入 antd
2018-04-10 12:08:41 +08:00
这是 vue-cli 生成的默认目录结构。
2018-04-09 22:49:58 +08:00
```
├── README.md
2018-04-10 12:08:41 +08:00
├── .babelrc
2018-04-09 22:49:58 +08:00
├── package.json
2018-04-10 12:08:41 +08:00
├── index.html
2018-04-09 22:49:58 +08:00
├── src
2018-04-10 12:08:41 +08:00
│   ├── assets
│ │ └── logo.png
│   ├── components
│ │ └── HelloWorld.vue
│   ├── App.vue
│   └── main.js
2018-04-09 22:49:58 +08:00
└── yarn.lock
```
2018-04-10 12:08:41 +08:00
现在从 yarn 或 npm 安装并引入 vue-antd-ui。
2018-04-09 22:49:58 +08:00
```bash
2018-04-10 12:08:41 +08:00
$ yarn add vue-antd-ui
2018-04-09 22:49:58 +08:00
```
2018-04-10 12:08:41 +08:00
修改 `src/main.js`,引入 antd 的按钮组件以及全部样式文件。
2018-04-09 22:49:58 +08:00
```jsx
2018-04-10 12:08:41 +08:00
import Vue from 'vue'
import Button from 'vue-antd-ui/lib/button'
import 'vue-antd-ui/dist/antd.css'
import App from './App'
2018-04-09 22:49:58 +08:00
2018-04-10 12:08:41 +08:00
Vue.component(Button.name, Button)
2018-04-09 22:49:58 +08:00
2018-04-10 12:08:41 +08:00
Vue.config.productionTip = false
2018-04-09 22:49:58 +08:00
2018-04-10 12:08:41 +08:00
/* eslint-disable no-new */
new Vue({
el: '#app',
components: { App },
template: '<App/>'
})
```
修改 `src/App.vue`的template内容。
2018-04-09 22:49:58 +08:00
2018-04-10 12:08:41 +08:00
```jsx
<template>
<div id="app">
<img src="./assets/logo.png">
<a-button type="primary">Button></a-button>
<router-view/>
</div>
</template>
2018-04-09 22:49:58 +08:00
...
```
2018-04-10 12:08:41 +08:00
好了,现在你应该能看到页面上已经有了 antd 的蓝色按钮组件,接下来就可以继续选用其他组件开发应用了。其他开发流程你可以参考 vue-cli 的[官方文档](https://github.com/vuejs/vue-cli/blob/master/README.md)。
2018-04-09 22:49:58 +08:00
## 高级配置
我们现在已经把组件成功运行起来了,但是在实际开发过程中还有很多问题,例如上面的例子实际上加载了全部的 antd 组件的样式(对前端性能是个隐患)。
2018-04-10 12:08:41 +08:00
此时我们需要对 vue-cli 的默认配置进行自定义。
2018-04-09 22:49:58 +08:00
### 使用 babel-plugin-import
2018-04-10 12:08:41 +08:00
[babel-plugin-import](https://github.com/ant-design/babel-plugin-import) 是一个用于按需加载组件代码和样式的 babel 插件([原理](/ant-design/docs/vue/getting-started#按需加载))。
2018-04-09 22:49:58 +08:00
```bash
$ yarn add babel-plugin-import --dev
```
2018-04-10 12:08:41 +08:00
修改`.babelrc`文件配置babel-plugin-import
2018-04-09 22:49:58 +08:00
```diff
2018-04-10 12:08:41 +08:00
{
"presets": [
["env", {
"modules": false,
"targets": {
"browsers": ["> 1%", "last 2 versions", "not ie <= 8"]
}
}],
"stage-2"
],
- "plugins": ["transform-vue-jsx", "transform-runtime"]
+ "plugins": [
+ "transform-vue-jsx",
+ "transform-runtime",
+ ["import", { "libraryName": "vue-antd-ui", "libraryDirectory": "es", "style": "css" }]
+ ]
2018-04-09 22:49:58 +08:00
}
```
2018-04-10 12:08:41 +08:00
然后移除前面在 `src/main.js` 里全量添加的 `import 'vue-antd-ui/dist/antd.css';` 样式代码,并且按下面的格式引入模块。
2018-04-09 22:49:58 +08:00
```diff
2018-04-10 12:08:41 +08:00
// src/main.js
import Vue from 'vue'
- import Button from 'vue-antd-ui/lib/button';
+ import { Button } from 'vue-antd-ui';
- import 'vue-antd-ui/dist/antd.css'
import App from './App'
2018-04-09 22:49:58 +08:00
2018-04-10 12:08:41 +08:00
Vue.component(Button.name, Button)
2018-04-09 22:49:58 +08:00
2018-04-10 12:08:41 +08:00
Vue.config.productionTip = false
2018-04-09 22:49:58 +08:00
2018-04-10 12:08:41 +08:00
/* eslint-disable no-new */
new Vue({
el: '#app',
components: { App },
template: '<App/>'
})
```
2018-04-09 22:49:58 +08:00
2018-04-10 12:08:41 +08:00
最后重启 `npm run dev` 访问页面antd 组件的 js 和 css 代码都会按需加载,你在控制台也不会看到这样的[警告信息](https://zos.alipayobjects.com/rmsportal/vgcHJRVZFmPjAawwVoXK.png)。关于按需加载的原理和其他方式可以阅读[这里](/ant-design/docs/vue/getting-started-cn#按需加载)。
2018-04-09 22:49:58 +08:00
2018-04-10 12:08:41 +08:00
### 自定义主题
2018-04-09 22:49:58 +08:00
2018-04-10 12:08:41 +08:00
按照 [配置主题](/ant-design/docs/vue/customize-theme-cn) 的要求,自定义主题需要用到 less 变量覆盖功能。
2018-04-09 22:49:58 +08:00