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

docs: add api title (#1990)

Browse Source
This commit is contained in:
neverland 2019-09-09 11:43:09 +08:00 committed by GitHub
parent 9e9cbd36b2
commit 84bec71f4a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
39 changed files with 98 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -14,6 +14,7 @@
## 代码演示
### 基础用法
需要传入一个`actions`的数组，数组的每一项是一个对象，对象属性见文档下方表格。
```html
@ -81,6 +82,8 @@ Page({
</van-action-sheet>
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

2
packages/area/README.md
View File

@ -41,6 +41,8 @@
<van-area area-list="{{ areaList }}" columns-num="{{ 2 }}" title="标题" />
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

3
packages/button/README.md
View File

@ -10,7 +10,6 @@
}
```
## 代码演示
### 按钮类型
@ -97,6 +96,8 @@
<van-button color="#7232dd" plain>自定义颜色</van-button>
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

3
packages/card/README.md
View File

@ -10,7 +10,6 @@
}
```
## 代码演示
### 基础用法
@ -45,6 +44,8 @@
</van-card>
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

3
packages/cell/README.md
View File

@ -11,7 +11,6 @@
}
```
## 代码演示
### 基础用法
@ -94,6 +93,8 @@
</van-cell>
```
## API
### CellGroup API
| 参数 | 说明 | 类型 | 默认值 | 版本 |

3
packages/checkbox/README.md
View File

@ -10,7 +10,6 @@
}
```
## 代码演示
### 基础用法
@ -188,6 +187,8 @@ Page({
}
```
## API
### Checkbox API
| 参数 | 说明 | 类型 | 默认值 | 版本 |

2
packages/col/README.md
View File

@ -51,6 +51,8 @@ Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置
</van-row>
```
## API
### Row API
| 参数 | 说明 | 类型 | 默认值 | 版本 |

2
packages/collapse/README.md
View File

@ -101,6 +101,8 @@ Page({
});
```
## API
### Collapse API
| 参数 | 说明 | 类型 | 默认值 | 版本 |

1
packages/common/README.md
View File

@ -29,6 +29,7 @@ Vant 中默认包含了一些常用样式，可以直接通过 className 的方
```
### 1px 边框
为元素添加 Retina 屏幕下的 1px 边框（即 hairline），基于伪类 transform 实现。
```html

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

@ -14,7 +14,6 @@
}
```
## 代码演示
### 选择完整时间
@ -171,6 +170,8 @@ Page({
});
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
@ -202,7 +203,7 @@ Page({
| confirm | 点击完成按钮时触发的事件 | 当前 value |
| cancel | 点击取消按钮时触发的事件 | - |
### change事件
### change 事件
在`change`事件中，可以获取到组件实例，对组件进行相应的更新等操作：

2
packages/dialog/README.md
View File

@ -16,7 +16,6 @@
}
```
## 代码演示
### 消息提示
@ -113,6 +112,7 @@ Page({
});
```
## API
### 方法

3
packages/field/README.md
View File

@ -14,7 +14,6 @@
}
```
## 代码演示
### 基础用法
@ -166,6 +165,8 @@ Page({
相关的讨论可以查看[微信开放社区](https://developers.weixin.qq.com/community/search?query=input%20%E6%89%8B%E5%86%99%E8%BE%93%E5%85%A5&page=1&block=1&random=1567079239098)
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

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

@ -1,6 +1,7 @@
# GoodsAction 商品导航
### 引入
在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart)
```json
@ -11,7 +12,6 @@
}
```
## 代码演示
### 基础用法
@ -66,6 +66,8 @@ Page({
</van-goods-action>
```
## API
### GoodsAction API
| 参数 | 说明 | 类型 | 默认值 | 版本 |

2
packages/icon/README.md
View File

@ -32,6 +32,8 @@
<van-icon name="chat" info="99+" />
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

3
packages/loading/README.md
View File

@ -10,7 +10,6 @@
}
```
## 代码演示
### Circular
@ -27,6 +26,8 @@
<van-loading type="spinner" color="#fff" />
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

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

@ -10,7 +10,6 @@
}
```
## 代码演示
### 基础用法
@ -46,6 +45,7 @@ Page({
</van-nav-bar>
```
## API
### Props

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

@ -48,6 +48,8 @@
/>
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

4
packages/notify/README.md
View File

@ -56,6 +56,8 @@ Notify({
<van-notify id="custom-selector" />
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
@ -66,4 +68,4 @@ Notify({
| color | 字体颜色 | *string* | `#fff` | - |
| background | 背景色 | *string* | `#ee0a24` | - |
| context | 选择器的选择范围，可以传入自定义组件的 this 作为上下文 | *object* | 当前页面 | - |
| safe-area-inset-top | 是否留出顶部安全距离（状态栏高度 + 导航栏高度） | *boolean* | `false` | - |
| safe-area-inset-top | 是否留出顶部安全距离（状态栏高度） | *boolean* | `false` | - |

3
packages/panel/README.md
View File

@ -1,6 +1,7 @@
# Panel 面板
### 引入
在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart)
```json
@ -33,6 +34,8 @@
</van-panel>
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

4
packages/picker/README.md
View File

@ -134,12 +134,15 @@ Page({
```
### 加载状态
当 Picker 数据是通过异步获取时，可以通过 `loading` 属性显示加载提示
```html
<van-picker columns="{{ columns }}" loading />
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
@ -165,7 +168,6 @@ Picker 组件的事件会根据 columns 是单列或多列返回不同的参数
| cancel | 点击取消按钮时触发 | 单列：选中值，选中值对应的索引<br>多列：所有列选中值，所有列选中值对应的索引 |
| change | 选项改变时触发 | 单列：Picker 实例，选中值，选中值对应的索引<br>多列：Picker 实例，所有列选中值，当前列对应的索引 |
### Columns 数据结构
当传入多列数据时，`columns`为一个对象数组，数组中的每一个对象配置每一列，每一列有以下`key`

2
packages/popup/README.md
View File

@ -95,6 +95,8 @@ Page({
/>
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

3
packages/progress/README.md
View File

@ -19,7 +19,6 @@
<van-progress percentage="50" />
```
### 置灰
```html
@ -51,6 +50,8 @@
/>
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

2
packages/radio/README.md
View File

@ -143,6 +143,8 @@ Page({
}
```
## API
### Radio API
| 参数 | 说明 | 类型 | 默认值 | 版本 |

4
packages/rate/README.md
View File

@ -1,6 +1,7 @@
# Rate 评分
### 引入
在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart)
```json
@ -55,6 +56,7 @@ Page({
```
### 半星
```html
<van-rate
value="{{ value }}"
@ -97,6 +99,8 @@ Page({
/>
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

2
packages/search/README.md
View File

@ -49,6 +49,8 @@
</van-search>
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

2
packages/sidebar/README.md
View File

@ -52,6 +52,8 @@ Page({
</van-sidebar>
```
## API
### Sidebar API
| 参数 | 说明 | 类型 | 默认值 | 版本 |

3
packages/slider/README.md
View File

@ -1,6 +1,7 @@
# Slider 滑块
### 引入
在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart)
```json
@ -82,6 +83,8 @@ Page({
});
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

2
packages/stepper/README.md
View File

@ -105,6 +105,8 @@ Page({
/>
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

2
packages/steps/README.md
View File

@ -70,6 +70,8 @@ Page({
/>
```
## API
### Steps API
| 参数 | 说明 | 类型 | 默认值 | 版本 |

3
packages/sticky/README.md
View File

@ -14,7 +14,6 @@ Sticky 组件与 CSS 中`position: sticky`属性实现的效果一致，当组
}
```
## 代码演示
### 基础用法
@ -37,6 +36,8 @@ Sticky 组件与 CSS 中`position: sticky`属性实现的效果一致，当组
</van-sticky>
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 |

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

@ -1,6 +1,7 @@
# SubmitBar 提交订单栏
### 引入
在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart)
```json
@ -22,6 +23,7 @@
```
### 禁用状态
禁用状态下不会触发`submit`事件
```html
@ -36,6 +38,7 @@
```
### 加载状态
加载状态下不会触发`submit`事件
```html
@ -48,6 +51,7 @@
```
### 高级用法
通过插槽插入自定义内容
```html
@ -64,6 +68,8 @@
</van-submit-bar>
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

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

@ -57,6 +57,8 @@ Page({
});
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

2
packages/switch/README.md
View File

@ -88,6 +88,8 @@ Page({
});
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

3
packages/tab/README.md
View File

@ -1,6 +1,7 @@
# Tab 标签页
### 引入
在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart)
```json
@ -151,6 +152,8 @@ Page({
</van-tabs>
```
## API
### Tabs API
| 参数 | 说明 | 类型 | 默认值 | 版本 |

3
packages/tabbar/README.md
View File

@ -1,6 +1,7 @@
# Tabbar 标签栏
### 引入
在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart)
```json
@ -142,6 +143,8 @@ Page({
请参考 [微信官方文档](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/custom-tabbar.html) 与 [代码片段](https://developers.weixin.qq.com/s/FjLU4mmp7r9s)
## API
### Tabbar API
| 参数 | 说明 | 类型 | 默认值 | 版本 |

4
packages/tag/README.md
View File

@ -14,7 +14,7 @@
### 基础用法
通过 type 属性控制 Tag 颜色，默认为灰色
通过`type`属性控制标签颜色，默认为灰色
```html
<van-tag>标签</van-tag>
@ -78,6 +78,8 @@
<van-tag type="danger" size="large">标签</van-tag>
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

2
packages/toast/README.md
View File

@ -69,6 +69,8 @@ const timer = setInterval(() => {
<van-toast id="custom-selector" />
```
## API
### 方法
| 方法名 | 参数 | 返回值 | 介绍 |

4
packages/transition/README.md
View File

@ -13,6 +13,7 @@
## 代码演示
### 基础用法
将元素包裹在 transition 组件内，在元素展示/隐藏时，会有相应的过渡动画
```html
@ -22,6 +23,7 @@
```
### 动画类型
transition 组件内置了多种动画，可以通过`name`字段指定动画类型
```html
@ -57,6 +59,8 @@ transition 组件内置了多种动画，可以通过`name`字段指定动画类
}
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |

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

@ -16,6 +16,7 @@
可以在任意位置上使用 van-tree-select 标签。传入对应的数据即可。
此组件支持单选或多选，具体行为完全基于事件 click-item 的实现逻辑如何为属性 active-id 赋值，当 active-id 为数组时即为多选状态。
```html
<van-tree-select
items="{{ items }}"
@ -87,13 +88,15 @@ Page({
});
```
## API
### Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-----------|-----------|
| items | 分类显示所需的数据，具体数据结构可看 数据结构 | *Array* | [] | - |
| main-active-index | 左侧导航高亮的索引 | *number* | 0 | - |
| active-id | 右侧选择项，高亮的数据id | *string \| number \| Array* | 0 | - |
| items | 分类显示所需的数据 | *Array* | `[]` | - |
| main-active-index | 左侧选中项的索引 | *number* | `0` | - |
| active-id | 右侧选中项的 id，支持传入数组 | *string \| number \| Array* | `0` | - |
### Events
@ -103,6 +106,7 @@ Page({
| bind:click-item | 右侧选择项被点击时，会触发的事件 | event.detail: 该点击项的数据 |
### items 数据结构
`items` 整体为一个数组，数组内包含一系列描述分类的对象
每个分类里，text 表示当前分类的名称。children 表示分类里的可选项，为数组结构，id 被用来唯一标识每个选项