blackteay/vant-weapp
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant-weapp.git synced 2025-04-06 03:58:05 +08:00
Code Issues Projects Releases Wiki Activity

[Doc] update quickstart.md

Browse Source
This commit is contained in:
陈嘉涵 2019-06-21 17:14:51 +08:00
parent b8e4188408
commit 006fbbc0a3
29 changed files with 57 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/markdown/quickstart.md
View File

@ -11,10 +11,10 @@
小程序已经支持使用 npm 安装第三方包，详见 [npm 支持](https://developers.weixin.qq.com/miniprogram/dev/devtools/npm.html?search-key=npm)
```bash
# npm
# 通过 npm 安装
npm i vant-weapp -S --production
# yarn
# 通过 yarn 安装
yarn add vant-weapp --production
```
@ -27,27 +27,27 @@ git clone https://github.com/youzan/vant-weapp.git
## 使用
### 使用组件
### 引入组件
以按钮组件为例，只需要在 json 文件中引入按钮对应的自定义组件即可
以 Button 组件为例，只需要在`app.json`或`index.json`中配置 Button 对应的路径即可。某些小程序框架会要求关闭`ES6转ES5`选项，可以引入`lib`目录下 ES5 版本的组件。
某些小程序框架会要求关闭`ES6转ES5`选项，可以引入`lib`目录内es5版本的组件
es6
#### ES6
```json
"usingComponents": {
"van-button": "/path/to/vant-weapp/dist/button/index"
}
```
es5
#### ES5
```json
"usingComponents": {
"van-button": "/path/to/vant-weapp/lib/button/index"
}
```
接着就可以在 wxml 中直接使用组件
### 使用组件
引入组件后，可以在 wxml 中直接使用组件
```xml
<van-button type="primary">按钮</van-button>

4
packages/action-sheet/README.md
View File

@ -81,7 +81,7 @@ Page({
</van-action-sheet>
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
@ -93,7 +93,7 @@ Page({
| close-on-click-overlay | 点击遮罩是否关闭菜单 | `Boolean` | - |
| safe-area-inset-bottom | 是否为iPhoneX留出底部安全距离 | `Boolean` | `true` |
### Event
### Events
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|

4
packages/area/README.md
View File

@ -41,7 +41,7 @@
<van-area area-list="{{ areaList }}" columns-num="{{ 2 }}" title="标题" />
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
@ -55,7 +55,7 @@
| confirm-button-text | 确认按钮文字 | `String` | `确认` |
| cancel-button-text | 取消按钮文字 | `String` | `取消` |
### Event
### Events
| 事件 | 说明 | 回调参数 |
| --- | --- | --- |

4
packages/button/README.md
View File

@ -76,7 +76,7 @@
<van-button size="mini">迷你按钮</van-button>
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
@ -102,7 +102,7 @@
| send-message-img | sendMessageImg | `String` | 截图 |
| show-message-card | 显示会话内消息卡片 | `String` | `false` |
### Event
### Events
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|

2
packages/card/README.md
View File

@ -45,7 +45,7 @@
</van-card>
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|

4
packages/datetime-picker/README.md
View File

@ -144,7 +144,7 @@ Page({
});
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|------|
@ -165,7 +165,7 @@ Page({
| cancel-button-text | 取消按钮文字 | `String` | `取消` |
| visible-item-count | 可见的选项个数 | `Number` | `5` |
### Event
### Events
| 事件名称 | 说明 | 回调参数 |
|------|------|------|

4
packages/dialog/README.md
View File

@ -159,7 +159,7 @@ Page({
| sendMessageImg | sendMessageImg | `String` | 截图 | `contact` |
| showMessageCard | 显示会话内消息卡片 | `String` | `false` | `contact` |
### API
### Props
通过组件调用 Dialog 时，支持以下 API：
@ -195,7 +195,7 @@ Page({
| send-message-img | sendMessageImg | `String` | 截图 | `contact` |
| show-message-card | 显示会话内消息卡片 | `String` | `false` | `contact` |
### Event
### Events
| 事件 | 说明 | 回调参数 |
|-----------|-----------|-----------|

4
packages/field/README.md
View File

@ -134,7 +134,7 @@ Page({
</van-cell-group>
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
@ -169,7 +169,7 @@ Page({
| adjust-position | 键盘弹起时，是否自动上推页面 | `Boolean` | `true` |
| show-confirm-bar | 是否显示键盘上方带有”完成“按钮那一栏，只对 textarea 有效 | `Boolean` | `true` |
### Event
### Events
| 事件 | 说明 | 回调参数 |
|-----------|-----------|-----------|

2
packages/goods-action/README.md
View File

@ -114,7 +114,7 @@ Page({
| send-message-img | sendMessageImg | `String` | 截图 |
| show-message-card | 显示会话内消息卡片 | `String` | `false` |
### Event
### Events
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|

4
packages/icon/README.md
View File

@ -28,7 +28,7 @@
<van-icon name="chat" info="99+" />
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
@ -39,7 +39,7 @@
| custom-style | 自定义样式 | `String` | - |
| class-prefix | 类名前缀 | `String` | `van-icon` |
### Event
### Events
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|

2
packages/loading/README.md
View File

@ -27,7 +27,7 @@
<van-loading type="spinner" color="#fff" />
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|

4
packages/nav-bar/README.md
View File

@ -47,7 +47,7 @@ Page({
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
@ -68,7 +68,7 @@ Page({
| left | 自定义左侧区域内容 |
| right | 自定义右侧区域内容 |
### Event
### Events
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|

4
packages/notice-bar/README.md
View File

@ -48,7 +48,7 @@
/>
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
@ -61,7 +61,7 @@
| backgroundColor | 滚动条背景 | `String` | `#fffbe8` |
| open-type | 微信开放能力 | `String` | `navigate` |
### Event
### Events
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|

2
packages/notify/README.md
View File

@ -38,7 +38,7 @@ Notify({
<van-notify id="custom-selector" />
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|

2
packages/panel/README.md
View File

@ -33,7 +33,7 @@
</van-panel>
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|

4
packages/picker/README.md
View File

@ -140,7 +140,7 @@ Page({
<van-picker columns="{{ columns }}" loading />
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
@ -155,7 +155,7 @@ Page({
| visible-item-count | 可见的选项个数 | `Number` | `5` |
| default-index | 单列选择器的默认选中项索引，<br>多列选择器请参考下方的 Columns 配置 | `Number` | `0` |
### Event
### Events
Picker 组件的事件会根据 columns 是单列或多列返回不同的参数

4
packages/popup/README.md
View File

@ -44,7 +44,7 @@ Page({
</van-popup>
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
@ -59,7 +59,7 @@ Page({
| safe-area-inset-bottom | 是否为iPhoneX留出底部安全距离 | `Boolean` | `true` |
| safe-area-inset-top | 是否留出顶部安全距离（状态栏高度 + 导航栏高度） | `Boolean` | `false` |
### Event
### Events
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|

2
packages/progress/README.md
View File

@ -51,7 +51,7 @@
/>
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|

4
packages/rate/README.md
View File

@ -97,7 +97,7 @@ Page({
/>
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
@ -114,7 +114,7 @@ Page({
| disabled | 是否禁用评分 | `Boolean` | `false` |
| disabled-color | 禁用时的颜色 | `String` | `#bdbdbd` |
### Event
### Events
| 事件名称 | 说明 | 回调参数 |
|------|------|------|

4
packages/search/README.md
View File

@ -46,7 +46,7 @@
</van-search>
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
@ -66,7 +66,7 @@
| placeholder-style | 指定 placeholder 的样式 | `String` | - |
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | `String` | `left` |
### Event
### Events
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|

4
packages/slider/README.md
View File

@ -110,7 +110,7 @@ Page({
});
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
@ -123,7 +123,7 @@ Page({
| active-color | 进度条激活态颜色 | `String` | `#1989fa` |
| inactive-color | 进度条默认颜色 | `String` | `#e5e5e5` |
### Event
### Events
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|

4
packages/stepper/README.md
View File

@ -41,7 +41,7 @@
/>
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
@ -56,7 +56,7 @@
| async-change | 异步变更，为 `true` 时input值不变化，仅触发事件 | `Boolean` | `false` |
| input-width | 输入框宽度，须指定单位 | `String` | `30px` |
### Event
### Events
| 事件名 | 说明 | 回调参数 |
|-----------|-----------|-----------|

4
packages/submit-bar/README.md
View File

@ -64,7 +64,7 @@
</van-submit-bar>
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
@ -81,7 +81,7 @@
| safe-area-inset-bottom | 是否为 iPhoneX 留出底部安全距离 | `Boolean` | `true` |
| decimal-length | 价格小数点后位数 | `Number` | `2` |
### Event
### Events
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|

4
packages/swipe-cell/README.md
View File

@ -57,7 +57,7 @@ Page({
});
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
@ -74,7 +74,7 @@ Page({
| left | 左侧滑动内容 |
| right | 右侧滑动内容 |
### Event
### Events
| 事件名 | 说明 | 参数 |
|------|------|------|

4
packages/switch-cell/README.md
View File

@ -58,7 +58,7 @@ Page({
/>
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
@ -73,7 +73,7 @@ Page({
| active-value | 打开时的值 | `any` | `true` |
| inactive-value | 关闭时的值 | `any` | `false` |
### Event
### Events
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|

4
packages/switch/README.md
View File

@ -88,7 +88,7 @@ Page({
});
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
@ -102,7 +102,7 @@ Page({
| active-value | 打开时的值 | `any` | `true` |
| inactive-value | 关闭时的值 | `any` | `false` |
### Event
### Events
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|

2
packages/tag/README.md
View File

@ -74,7 +74,7 @@
<van-tag size="large">标签</van-tag>
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|

2
packages/transition/README.md
View File

@ -57,7 +57,7 @@ transition 组件内置了多种动画，可以通过`name`字段指定动画类
}
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|

4
packages/tree-select/README.md
View File

@ -46,7 +46,7 @@ Page({
});
```
### API
### Props
| 参数 | 说明 | 类型 | 默认值 | 必须 |
|-----------|-----------|-----------|-------------|-------------|
@ -54,7 +54,7 @@ Page({
| main-active-index | 左侧导航高亮的索引 | Number | 0 | |
| active-id | 右侧选择项，高亮的数据id | String | Number | 0 | |
### Event
### Events
| 事件名 | 说明 | 回调参数 |
|-----------|-----------|-----------|