vant/docs/markdown/zh-CN/quickstart.md
2017-11-30 19:05:54 +08:00

80 lines
1.6 KiB
Markdown

## Vant
基于`Vue 2.0`的 Mobile 组件库
### 安装
```shell
npm i vant -S
```
### 引入组件
#### 方式一. 使用 [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) (推荐)
```bash
# 安装 babel-plugin-import 插件
npm i babel-plugin-import -D
```
```js
// 在 .babelrc 或 babel-loader 中添加插件配置
{
"plugins": [
["import", { "libraryName": "vant", "style": true }]
]
}
```
接着你可以在代码中直接引入 Vant 组件,插件会自动将代码转化为方式二中的按需引入形式。
```js
import { Button } from 'vant';
```
#### 方式二. 按需引入组件
```js
import { Button } from 'vant/lib/button';
import 'vant/lib/vant-css/base.css';
import 'vant/lib/vant-css/button.css';
```
#### 方式三. 导入所有组件
```js
import Vue from 'vue';
import Vant from 'vant';
import 'vant/lib/vant-css/index.css';
Vue.use(Vant);
```
### CDN
```html
<!-- 引入样式 -->
<link rel="stylesheet" href="https://unpkg.com/vant/lib/vant-css/index.css">
<!-- 引入组件 -->
<script src="https://unpkg.com/vant/lib/vant.min.js"></script>
```
### vue-cli 模板
可以使用`vue-cli`来初始化`Vant`的通用模板:
```shell
vue init youzan/vue-cli-template-vant projectName
```
### Props 命名风格
Vant 文档中的 props 默认采用驼峰式命名 (camelCase)。由于 HTML 特性是不区分大小写的,如果在 HTML 中直接书写 Vue 模板,需要使用短横线分割式 (kebab-case) 的命名来传递 props
``` html
<!-- 在 JavaScript 中使用 camelCase -->
<van-cell isLink />
<!-- 在 HTML 中使用 kebab-case-->
<van-cell is-link />
```