diff --git a/docs/markdown/quickstart.md b/docs/markdown/quickstart.md index 3898020e..f196e5aa 100644 --- a/docs/markdown/quickstart.md +++ b/docs/markdown/quickstart.md @@ -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 按钮 diff --git a/packages/action-sheet/README.md b/packages/action-sheet/README.md index f541a252..fc7cd396 100644 --- a/packages/action-sheet/README.md +++ b/packages/action-sheet/README.md @@ -81,7 +81,7 @@ Page({ ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| @@ -93,7 +93,7 @@ Page({ | close-on-click-overlay | 点击遮罩是否关闭菜单 | `Boolean` | - | | safe-area-inset-bottom | 是否为iPhoneX留出底部安全距离 | `Boolean` | `true` | -### Event +### Events | 事件名 | 说明 | 参数 | |-----------|-----------|-----------| diff --git a/packages/area/README.md b/packages/area/README.md index 0093fadb..179e8a9c 100644 --- a/packages/area/README.md +++ b/packages/area/README.md @@ -41,7 +41,7 @@ ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | @@ -55,7 +55,7 @@ | confirm-button-text | 确认按钮文字 | `String` | `确认` | | cancel-button-text | 取消按钮文字 | `String` | `取消` | -### Event +### Events | 事件 | 说明 | 回调参数 | | --- | --- | --- | diff --git a/packages/button/README.md b/packages/button/README.md index f3105486..49720e0c 100644 --- a/packages/button/README.md +++ b/packages/button/README.md @@ -76,7 +76,7 @@ 迷你按钮 ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| @@ -102,7 +102,7 @@ | send-message-img | sendMessageImg | `String` | 截图 | | show-message-card | 显示会话内消息卡片 | `String` | `false` | -### Event +### Events | 事件名 | 说明 | 参数 | |-----------|-----------|-----------| diff --git a/packages/card/README.md b/packages/card/README.md index ea0010c8..4243c840 100644 --- a/packages/card/README.md +++ b/packages/card/README.md @@ -45,7 +45,7 @@ ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| diff --git a/packages/datetime-picker/README.md b/packages/datetime-picker/README.md index d99cbdcb..2c3c781e 100644 --- a/packages/datetime-picker/README.md +++ b/packages/datetime-picker/README.md @@ -144,7 +144,7 @@ Page({ }); ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |------|------|------|------|------| @@ -165,7 +165,7 @@ Page({ | cancel-button-text | 取消按钮文字 | `String` | `取消` | | visible-item-count | 可见的选项个数 | `Number` | `5` | -### Event +### Events | 事件名称 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/dialog/README.md b/packages/dialog/README.md index 5f089a35..11ac6649 100644 --- a/packages/dialog/README.md +++ b/packages/dialog/README.md @@ -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 | 事件 | 说明 | 回调参数 | |-----------|-----------|-----------| diff --git a/packages/field/README.md b/packages/field/README.md index b9f24062..8dabed8e 100644 --- a/packages/field/README.md +++ b/packages/field/README.md @@ -134,7 +134,7 @@ Page({ ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| @@ -169,7 +169,7 @@ Page({ | adjust-position | 键盘弹起时,是否自动上推页面 | `Boolean` | `true` | | show-confirm-bar | 是否显示键盘上方带有”完成“按钮那一栏,只对 textarea 有效 | `Boolean` | `true` | -### Event +### Events | 事件 | 说明 | 回调参数 | |-----------|-----------|-----------| diff --git a/packages/goods-action/README.md b/packages/goods-action/README.md index e05b164a..a007f290 100644 --- a/packages/goods-action/README.md +++ b/packages/goods-action/README.md @@ -114,7 +114,7 @@ Page({ | send-message-img | sendMessageImg | `String` | 截图 | | show-message-card | 显示会话内消息卡片 | `String` | `false` | -### Event +### Events | 事件名 | 说明 | 参数 | |-----------|-----------|-----------| diff --git a/packages/icon/README.md b/packages/icon/README.md index 9a484926..9725c04a 100644 --- a/packages/icon/README.md +++ b/packages/icon/README.md @@ -28,7 +28,7 @@ ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| @@ -39,7 +39,7 @@ | custom-style | 自定义样式 | `String` | - | | class-prefix | 类名前缀 | `String` | `van-icon` | -### Event +### Events | 事件名 | 说明 | 参数 | |-----------|-----------|-----------| diff --git a/packages/loading/README.md b/packages/loading/README.md index c39d5664..7f696104 100644 --- a/packages/loading/README.md +++ b/packages/loading/README.md @@ -27,7 +27,7 @@ ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| diff --git a/packages/nav-bar/README.md b/packages/nav-bar/README.md index 70869ed5..c96afd45 100644 --- a/packages/nav-bar/README.md +++ b/packages/nav-bar/README.md @@ -47,7 +47,7 @@ Page({ ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| @@ -68,7 +68,7 @@ Page({ | left | 自定义左侧区域内容 | | right | 自定义右侧区域内容 | -### Event +### Events | 事件名 | 说明 | 参数 | |-----------|-----------|-----------| diff --git a/packages/notice-bar/README.md b/packages/notice-bar/README.md index 44c0e2e2..38e9abed 100644 --- a/packages/notice-bar/README.md +++ b/packages/notice-bar/README.md @@ -48,7 +48,7 @@ /> ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| @@ -61,7 +61,7 @@ | backgroundColor | 滚动条背景 | `String` | `#fffbe8` | | open-type | 微信开放能力 | `String` | `navigate` | -### Event +### Events | 事件名 | 说明 | 参数 | |-----------|-----------|-----------| diff --git a/packages/notify/README.md b/packages/notify/README.md index 5317097c..447a66c0 100644 --- a/packages/notify/README.md +++ b/packages/notify/README.md @@ -38,7 +38,7 @@ Notify({ ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| diff --git a/packages/panel/README.md b/packages/panel/README.md index a87ab4ea..40b93087 100644 --- a/packages/panel/README.md +++ b/packages/panel/README.md @@ -33,7 +33,7 @@ ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| diff --git a/packages/picker/README.md b/packages/picker/README.md index 5b38a7e7..e8dbea20 100644 --- a/packages/picker/README.md +++ b/packages/picker/README.md @@ -140,7 +140,7 @@ Page({ ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |------|------|------|------| @@ -155,7 +155,7 @@ Page({ | visible-item-count | 可见的选项个数 | `Number` | `5` | | default-index | 单列选择器的默认选中项索引,
多列选择器请参考下方的 Columns 配置 | `Number` | `0` | -### Event +### Events Picker 组件的事件会根据 columns 是单列或多列返回不同的参数 diff --git a/packages/popup/README.md b/packages/popup/README.md index 295d70ea..c77a8aec 100644 --- a/packages/popup/README.md +++ b/packages/popup/README.md @@ -44,7 +44,7 @@ Page({ ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| @@ -59,7 +59,7 @@ Page({ | safe-area-inset-bottom | 是否为iPhoneX留出底部安全距离 | `Boolean` | `true` | | safe-area-inset-top | 是否留出顶部安全距离(状态栏高度 + 导航栏高度) | `Boolean` | `false` | -### Event +### Events | 事件名 | 说明 | 参数 | |-----------|-----------|-----------| diff --git a/packages/progress/README.md b/packages/progress/README.md index a7afa5f3..03c1181e 100644 --- a/packages/progress/README.md +++ b/packages/progress/README.md @@ -51,7 +51,7 @@ /> ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| diff --git a/packages/rate/README.md b/packages/rate/README.md index b156bbda..85ee3483 100644 --- a/packages/rate/README.md +++ b/packages/rate/README.md @@ -97,7 +97,7 @@ Page({ /> ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |------|------|------|------| @@ -114,7 +114,7 @@ Page({ | disabled | 是否禁用评分 | `Boolean` | `false` | | disabled-color | 禁用时的颜色 | `String` | `#bdbdbd` | -### Event +### Events | 事件名称 | 说明 | 回调参数 | |------|------|------| diff --git a/packages/search/README.md b/packages/search/README.md index 40daf719..984e7b6c 100644 --- a/packages/search/README.md +++ b/packages/search/README.md @@ -46,7 +46,7 @@ ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| @@ -66,7 +66,7 @@ | placeholder-style | 指定 placeholder 的样式 | `String` | - | | input-align | 输入框内容对齐方式,可选值为 `center` `right` | `String` | `left` | -### Event +### Events | 事件名 | 说明 | 参数 | |-----------|-----------|-----------| diff --git a/packages/slider/README.md b/packages/slider/README.md index 71808cea..daad3989 100644 --- a/packages/slider/README.md +++ b/packages/slider/README.md @@ -110,7 +110,7 @@ Page({ }); ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| @@ -123,7 +123,7 @@ Page({ | active-color | 进度条激活态颜色 | `String` | `#1989fa` | | inactive-color | 进度条默认颜色 | `String` | `#e5e5e5` | -### Event +### Events | 事件名 | 说明 | 参数 | |-----------|-----------|-----------| diff --git a/packages/stepper/README.md b/packages/stepper/README.md index 49834032..3e0895eb 100644 --- a/packages/stepper/README.md +++ b/packages/stepper/README.md @@ -41,7 +41,7 @@ /> ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| @@ -56,7 +56,7 @@ | async-change | 异步变更,为 `true` 时input值不变化,仅触发事件 | `Boolean` | `false` | | input-width | 输入框宽度,须指定单位 | `String` | `30px` | -### Event +### Events | 事件名 | 说明 | 回调参数 | |-----------|-----------|-----------| diff --git a/packages/submit-bar/README.md b/packages/submit-bar/README.md index 87432e9f..96dc67b1 100644 --- a/packages/submit-bar/README.md +++ b/packages/submit-bar/README.md @@ -64,7 +64,7 @@ ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| @@ -81,7 +81,7 @@ | safe-area-inset-bottom | 是否为 iPhoneX 留出底部安全距离 | `Boolean` | `true` | | decimal-length | 价格小数点后位数 | `Number` | `2` | -### Event +### Events | 事件名 | 说明 | 参数 | |-----------|-----------|-----------| diff --git a/packages/swipe-cell/README.md b/packages/swipe-cell/README.md index 110352ae..e7285f53 100644 --- a/packages/swipe-cell/README.md +++ b/packages/swipe-cell/README.md @@ -57,7 +57,7 @@ Page({ }); ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| @@ -74,7 +74,7 @@ Page({ | left | 左侧滑动内容 | | right | 右侧滑动内容 | -### Event +### Events | 事件名 | 说明 | 参数 | |------|------|------| diff --git a/packages/switch-cell/README.md b/packages/switch-cell/README.md index 45241a62..bcaa8fb3 100644 --- a/packages/switch-cell/README.md +++ b/packages/switch-cell/README.md @@ -58,7 +58,7 @@ Page({ /> ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| @@ -73,7 +73,7 @@ Page({ | active-value | 打开时的值 | `any` | `true` | | inactive-value | 关闭时的值 | `any` | `false` | -### Event +### Events | 事件名 | 说明 | 参数 | |-----------|-----------|-----------| diff --git a/packages/switch/README.md b/packages/switch/README.md index 3c5a2f5a..ae5199fb 100644 --- a/packages/switch/README.md +++ b/packages/switch/README.md @@ -88,7 +88,7 @@ Page({ }); ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| @@ -102,7 +102,7 @@ Page({ | active-value | 打开时的值 | `any` | `true` | | inactive-value | 关闭时的值 | `any` | `false` | -### Event +### Events | 事件名 | 说明 | 参数 | |-----------|-----------|-----------| diff --git a/packages/tag/README.md b/packages/tag/README.md index f2ce23d4..14afba5f 100644 --- a/packages/tag/README.md +++ b/packages/tag/README.md @@ -74,7 +74,7 @@ 标签 ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| diff --git a/packages/transition/README.md b/packages/transition/README.md index c4ded333..148dff20 100644 --- a/packages/transition/README.md +++ b/packages/transition/README.md @@ -57,7 +57,7 @@ transition 组件内置了多种动画,可以通过`name`字段指定动画类 } ``` -### API +### Props | 参数 | 说明 | 类型 | 默认值 | |-----------|-----------|-----------|-------------| diff --git a/packages/tree-select/README.md b/packages/tree-select/README.md index c26e3251..5eb723c1 100644 --- a/packages/tree-select/README.md +++ b/packages/tree-select/README.md @@ -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 | 事件名 | 说明 | 回调参数 | |-----------|-----------|-----------|