diff --git a/packages/action-sheet/README.md b/packages/action-sheet/README.md index 61201662..335ba169 100644 --- a/packages/action-sheet/README.md +++ b/packages/action-sheet/README.md @@ -14,6 +14,7 @@ ## 代码演示 ### 基础用法 + 需要传入一个`actions`的数组,数组的每一项是一个对象,对象属性见文档下方表格。 ```html @@ -81,6 +82,8 @@ Page({ ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/area/README.md b/packages/area/README.md index 660dd866..653687a5 100644 --- a/packages/area/README.md +++ b/packages/area/README.md @@ -41,6 +41,8 @@ ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/button/README.md b/packages/button/README.md index 463264b1..09534240 100644 --- a/packages/button/README.md +++ b/packages/button/README.md @@ -10,7 +10,6 @@ } ``` - ## 代码演示 ### 按钮类型 @@ -97,6 +96,8 @@ 自定义颜色 ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/card/README.md b/packages/card/README.md index 6ed10e06..d8693fb5 100644 --- a/packages/card/README.md +++ b/packages/card/README.md @@ -10,7 +10,6 @@ } ``` - ## 代码演示 ### 基础用法 @@ -45,6 +44,8 @@ ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/cell/README.md b/packages/cell/README.md index 981e75b0..b926aad8 100644 --- a/packages/cell/README.md +++ b/packages/cell/README.md @@ -11,7 +11,6 @@ } ``` - ## 代码演示 ### 基础用法 @@ -94,6 +93,8 @@ ``` +## API + ### CellGroup API | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/checkbox/README.md b/packages/checkbox/README.md index 88faf7b3..1b2f56fb 100644 --- a/packages/checkbox/README.md +++ b/packages/checkbox/README.md @@ -10,7 +10,6 @@ } ``` - ## 代码演示 ### 基础用法 @@ -188,6 +187,8 @@ Page({ } ``` +## API + ### Checkbox API | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/col/README.md b/packages/col/README.md index c9a6613c..9d437d5c 100644 --- a/packages/col/README.md +++ b/packages/col/README.md @@ -51,6 +51,8 @@ Layout 组件提供了`24列栅格`,通过在`Col`上添加`span`属性设置 ``` +## API + ### Row API | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/collapse/README.md b/packages/collapse/README.md index b36df10a..94e36358 100644 --- a/packages/collapse/README.md +++ b/packages/collapse/README.md @@ -101,6 +101,8 @@ Page({ }); ``` +## API + ### Collapse API | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/common/README.md b/packages/common/README.md index 7bec6aed..2ad3d727 100644 --- a/packages/common/README.md +++ b/packages/common/README.md @@ -29,6 +29,7 @@ Vant 中默认包含了一些常用样式,可以直接通过 className 的方 ``` ### 1px 边框 + 为元素添加 Retina 屏幕下的 1px 边框(即 hairline),基于伪类 transform 实现。 ```html diff --git a/packages/datetime-picker/README.md b/packages/datetime-picker/README.md index afe4f77f..5f2d15e8 100644 --- a/packages/datetime-picker/README.md +++ b/packages/datetime-picker/README.md @@ -14,7 +14,6 @@ } ``` - ## 代码演示 ### 选择完整时间 @@ -171,6 +170,8 @@ Page({ }); ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | @@ -202,7 +203,7 @@ Page({ | confirm | 点击完成按钮时触发的事件 | 当前 value | | cancel | 点击取消按钮时触发的事件 | - | -### change事件 +### change 事件 在`change`事件中,可以获取到组件实例,对组件进行相应的更新等操作: diff --git a/packages/dialog/README.md b/packages/dialog/README.md index 653e3e29..05bfcb33 100644 --- a/packages/dialog/README.md +++ b/packages/dialog/README.md @@ -16,7 +16,6 @@ } ``` - ## 代码演示 ### 消息提示 @@ -113,6 +112,7 @@ Page({ }); ``` +## API ### 方法 diff --git a/packages/field/README.md b/packages/field/README.md index 4776eb28..ebd1d8fc 100644 --- a/packages/field/README.md +++ b/packages/field/README.md @@ -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 | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/goods-action/README.md b/packages/goods-action/README.md index 82038fe5..5306e8d4 100644 --- a/packages/goods-action/README.md +++ b/packages/goods-action/README.md @@ -1,6 +1,7 @@ # GoodsAction 商品导航 ### 引入 + 在`app.json`或`index.json`中引入组件,默认为`ES6`版本,`ES5`引入方式参见[快速上手](#/quickstart) ```json @@ -11,7 +12,6 @@ } ``` - ## 代码演示 ### 基础用法 @@ -66,6 +66,8 @@ Page({ ``` +## API + ### GoodsAction API | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/icon/README.md b/packages/icon/README.md index 6b0cf1f2..13a7d09e 100644 --- a/packages/icon/README.md +++ b/packages/icon/README.md @@ -32,6 +32,8 @@ ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/loading/README.md b/packages/loading/README.md index 13bfde96..c05660d3 100644 --- a/packages/loading/README.md +++ b/packages/loading/README.md @@ -10,7 +10,6 @@ } ``` - ## 代码演示 ### Circular @@ -27,6 +26,8 @@ ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/nav-bar/README.md b/packages/nav-bar/README.md index 25eca1b2..8c75faa4 100644 --- a/packages/nav-bar/README.md +++ b/packages/nav-bar/README.md @@ -10,7 +10,6 @@ } ``` - ## 代码演示 ### 基础用法 @@ -46,6 +45,7 @@ Page({ ``` +## API ### Props diff --git a/packages/notice-bar/README.md b/packages/notice-bar/README.md index 73fd3623..a206e194 100644 --- a/packages/notice-bar/README.md +++ b/packages/notice-bar/README.md @@ -48,6 +48,8 @@ /> ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/notify/README.md b/packages/notify/README.md index bfb45144..b3e07910 100644 --- a/packages/notify/README.md +++ b/packages/notify/README.md @@ -56,6 +56,8 @@ Notify({ ``` +## 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` | - | diff --git a/packages/panel/README.md b/packages/panel/README.md index 623bc1fe..fd48d596 100644 --- a/packages/panel/README.md +++ b/packages/panel/README.md @@ -1,6 +1,7 @@ # Panel 面板 ### 引入 + 在`app.json`或`index.json`中引入组件,默认为`ES6`版本,`ES5`引入方式参见[快速上手](#/quickstart) ```json @@ -33,6 +34,8 @@ ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/picker/README.md b/packages/picker/README.md index 594fc3a4..5040c668 100644 --- a/packages/picker/README.md +++ b/packages/picker/README.md @@ -134,12 +134,15 @@ Page({ ``` ### 加载状态 + 当 Picker 数据是通过异步获取时,可以通过 `loading` 属性显示加载提示 ```html ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | @@ -165,7 +168,6 @@ Picker 组件的事件会根据 columns 是单列或多列返回不同的参数 | cancel | 点击取消按钮时触发 | 单列:选中值,选中值对应的索引
多列:所有列选中值,所有列选中值对应的索引 | | change | 选项改变时触发 | 单列:Picker 实例,选中值,选中值对应的索引
多列:Picker 实例,所有列选中值,当前列对应的索引 | - ### Columns 数据结构 当传入多列数据时,`columns`为一个对象数组,数组中的每一个对象配置每一列,每一列有以下`key` diff --git a/packages/popup/README.md b/packages/popup/README.md index 74b37368..b94b7644 100644 --- a/packages/popup/README.md +++ b/packages/popup/README.md @@ -95,6 +95,8 @@ Page({ /> ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/progress/README.md b/packages/progress/README.md index 5f079dc1..7c6a3a62 100644 --- a/packages/progress/README.md +++ b/packages/progress/README.md @@ -19,7 +19,6 @@ ``` - ### 置灰 ```html @@ -51,6 +50,8 @@ /> ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/radio/README.md b/packages/radio/README.md index f3d330ff..26d8c031 100644 --- a/packages/radio/README.md +++ b/packages/radio/README.md @@ -143,6 +143,8 @@ Page({ } ``` +## API + ### Radio API | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/rate/README.md b/packages/rate/README.md index f5194c92..69b7d8ca 100644 --- a/packages/rate/README.md +++ b/packages/rate/README.md @@ -1,6 +1,7 @@ # Rate 评分 ### 引入 + 在`app.json`或`index.json`中引入组件,默认为`ES6`版本,`ES5`引入方式参见[快速上手](#/quickstart) ```json @@ -55,6 +56,7 @@ Page({ ``` ### 半星 + ```html ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/search/README.md b/packages/search/README.md index 9274b281..4eee846d 100644 --- a/packages/search/README.md +++ b/packages/search/README.md @@ -49,6 +49,8 @@ ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/sidebar/README.md b/packages/sidebar/README.md index 27277c92..0d0a3214 100644 --- a/packages/sidebar/README.md +++ b/packages/sidebar/README.md @@ -52,6 +52,8 @@ Page({ ``` +## API + ### Sidebar API | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/slider/README.md b/packages/slider/README.md index 2921508c..d979ffba 100644 --- a/packages/slider/README.md +++ b/packages/slider/README.md @@ -1,6 +1,7 @@ # Slider 滑块 ### 引入 + 在`app.json`或`index.json`中引入组件,默认为`ES6`版本,`ES5`引入方式参见[快速上手](#/quickstart) ```json @@ -82,6 +83,8 @@ Page({ }); ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/stepper/README.md b/packages/stepper/README.md index e72e47b1..94b4a7e8 100644 --- a/packages/stepper/README.md +++ b/packages/stepper/README.md @@ -105,6 +105,8 @@ Page({ /> ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/steps/README.md b/packages/steps/README.md index d7eb1298..eeb6cc96 100644 --- a/packages/steps/README.md +++ b/packages/steps/README.md @@ -70,6 +70,8 @@ Page({ /> ``` +## API + ### Steps API | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/sticky/README.md b/packages/sticky/README.md index 1360afee..e27dd974 100644 --- a/packages/sticky/README.md +++ b/packages/sticky/README.md @@ -14,7 +14,6 @@ Sticky 组件与 CSS 中`position: sticky`属性实现的效果一致,当组 } ``` - ## 代码演示 ### 基础用法 @@ -37,6 +36,8 @@ Sticky 组件与 CSS 中`position: sticky`属性实现的效果一致,当组 ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | diff --git a/packages/submit-bar/README.md b/packages/submit-bar/README.md index 2e2a5b7a..8160ce03 100644 --- a/packages/submit-bar/README.md +++ b/packages/submit-bar/README.md @@ -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 @@ ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/swipe-cell/README.md b/packages/swipe-cell/README.md index c89bb3d8..9cc67278 100644 --- a/packages/swipe-cell/README.md +++ b/packages/swipe-cell/README.md @@ -57,6 +57,8 @@ Page({ }); ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/switch/README.md b/packages/switch/README.md index 232f5d6c..2e509270 100644 --- a/packages/switch/README.md +++ b/packages/switch/README.md @@ -88,6 +88,8 @@ Page({ }); ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/tab/README.md b/packages/tab/README.md index 68244547..24d73f81 100644 --- a/packages/tab/README.md +++ b/packages/tab/README.md @@ -1,6 +1,7 @@ # Tab 标签页 ### 引入 + 在`app.json`或`index.json`中引入组件,默认为`ES6`版本,`ES5`引入方式参见[快速上手](#/quickstart) ```json @@ -151,6 +152,8 @@ Page({ ``` +## API + ### Tabs API | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/tabbar/README.md b/packages/tabbar/README.md index b7ab9c3b..87d4b1c8 100644 --- a/packages/tabbar/README.md +++ b/packages/tabbar/README.md @@ -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 | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/tag/README.md b/packages/tag/README.md index db12b950..7e6552e2 100644 --- a/packages/tag/README.md +++ b/packages/tag/README.md @@ -14,7 +14,7 @@ ### 基础用法 -通过 type 属性控制 Tag 颜色,默认为灰色 +通过`type`属性控制标签颜色,默认为灰色 ```html 标签 @@ -78,6 +78,8 @@ 标签 ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/toast/README.md b/packages/toast/README.md index b7443571..0a15feb8 100644 --- a/packages/toast/README.md +++ b/packages/toast/README.md @@ -69,6 +69,8 @@ const timer = setInterval(() => { ``` +## API + ### 方法 | 方法名 | 参数 | 返回值 | 介绍 | diff --git a/packages/transition/README.md b/packages/transition/README.md index a85481ac..56d5311c 100644 --- a/packages/transition/README.md +++ b/packages/transition/README.md @@ -13,6 +13,7 @@ ## 代码演示 ### 基础用法 + 将元素包裹在 transition 组件内,在元素展示/隐藏时,会有相应的过渡动画 ```html @@ -22,6 +23,7 @@ ``` ### 动画类型 + transition 组件内置了多种动画,可以通过`name`字段指定动画类型 ```html @@ -57,6 +59,8 @@ transition 组件内置了多种动画,可以通过`name`字段指定动画类 } ``` +## API + ### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/packages/tree-select/README.md b/packages/tree-select/README.md index 5354aee7..7dfcaabe 100644 --- a/packages/tree-select/README.md +++ b/packages/tree-select/README.md @@ -16,6 +16,7 @@ 可以在任意位置上使用 van-tree-select 标签。传入对应的数据即可。 此组件支持单选或多选,具体行为完全基于事件 click-item 的实现逻辑如何为属性 active-id 赋值,当 active-id 为数组时即为多选状态。 + ```html