From c024430d4f4628e8448c8960cfa3a03eef5d8d23 Mon Sep 17 00:00:00 2001 From: dengrongyao Date: Mon, 12 Apr 2021 17:55:08 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E7=BB=9F=E4=B8=80=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E6=A0=87=E7=82=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/action-sheet/README.md | 8 ++++---- packages/area/README.md | 18 +++++++++--------- packages/button/README.md | 18 +++++++++--------- packages/calendar/README.md | 20 ++++++++++---------- packages/card/README.md | 4 ++-- packages/cell/README.md | 16 ++++++++-------- packages/checkbox/README.md | 22 +++++++++++----------- packages/circle/README.md | 12 ++++++------ packages/col/README.md | 8 ++++---- packages/collapse/README.md | 6 +++--- packages/common/README.md | 8 ++++---- packages/count-down/README.md | 16 ++++++++-------- packages/datetime-picker/README.md | 14 +++++++------- packages/dialog/README.md | 6 +++--- packages/divider/README.md | 2 +- packages/dropdown-menu/README.md | 4 ++-- packages/empty/README.md | 10 +++++----- packages/field/README.md | 24 ++++++++++++------------ packages/goods-action/README.md | 10 +++++----- packages/grid/README.md | 20 ++++++++++---------- packages/icon/README.md | 12 ++++++------ packages/image/README.md | 14 +++++++------- packages/index-bar/README.md | 6 +++--- packages/loading/README.md | 2 +- packages/nav-bar/README.md | 4 ++-- packages/notice-bar/README.md | 4 ++-- packages/notify/README.md | 6 +++--- packages/overlay/README.md | 6 +++--- packages/panel/README.md | 6 +++--- packages/picker/README.md | 16 ++++++++-------- packages/popup/README.md | 12 ++++++------ packages/progress/README.md | 8 ++++---- packages/radio/README.md | 16 ++++++++-------- packages/rate/README.md | 2 +- packages/search/README.md | 10 +++++----- packages/share-sheet/README.md | 2 +- packages/sidebar/README.md | 10 +++++----- packages/skeleton/README.md | 8 ++++---- packages/slider/README.md | 2 +- packages/stepper/README.md | 22 +++++++++++----------- packages/steps/README.md | 8 ++++---- packages/sticky/README.md | 10 +++++----- packages/submit-bar/README.md | 8 ++++---- packages/swipe-cell/README.md | 4 ++-- packages/switch/README.md | 2 +- packages/tab/README.md | 24 ++++++++++++------------ packages/tabbar/README.md | 8 ++++---- packages/tag/README.md | 2 +- packages/toast/README.md | 2 +- packages/transition/README.md | 8 ++++---- packages/tree-select/README.md | 6 ++---- packages/uploader/README.md | 12 ++++++------ 52 files changed, 253 insertions(+), 255 deletions(-) diff --git a/packages/action-sheet/README.md b/packages/action-sheet/README.md index 369af168..68e29078 100644 --- a/packages/action-sheet/README.md +++ b/packages/action-sheet/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -85,7 +85,7 @@ Page({ ### 展示取消按钮 -设置`cancel-text`属`性后，会在底部展示取消按钮，点击后关闭当前菜单 +设置`cancel-text`属`性后，会在底部展示取消按钮，点击后关闭当前菜单。 ```html diff --git a/packages/area/README.md b/packages/area/README.md index 56b7e380..c4475532 100644 --- a/packages/area/README.md +++ b/packages/area/README.md @@ -2,11 +2,11 @@ ### 介绍 -省市区选择组件通常与 [弹出层](#/popup) 组件配合使用 +省市区选择组件通常与 [弹出层](#/popup) 组件配合使用。 ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -52,7 +52,7 @@ const areaList = { ### @vant/area-data -Vant 官方提供了一份默认的省市区数据，可以通过 [@vant/area-data](https://github.com/youzan/vant/tree/dev/packages/vant-area-data) 引入： +Vant 官方提供了一份默认的省市区数据，可以通过 [@vant/area-data](https://github.com/youzan/vant/tree/dev/packages/vant-area-data) 引入。 ```bash yarn add @vant/area-data @@ -70,7 +70,7 @@ Page({ ### 选中省市区 -如果想选中某个省市区，需要传入一个`value`属性，绑定对应的省市区`code` +如果想选中某个省市区，需要传入一个`value`属性，绑定对应的省市区`code`。 ```html @@ -78,7 +78,7 @@ Page({ ### 配置显示列 -可以通过`columns-num`属性配置省市区显示的列数，默认情况下会显示省市区，当你设置为`2`，则只会显示省市选择 +可以通过`columns-num`属性配置省市区显示的列数，默认情况下会显示省市区，当你设置为`2`，则只会显示省市选择。 ```html @@ -86,7 +86,7 @@ Page({ ### 配置列占位提示文字 -可以通过`columns-placeholder`属性配置每一列的占位提示文字 +可以通过`columns-placeholder`属性配置每一列的占位提示文字。 ```html 默认按钮 @@ -30,7 +30,7 @@ ### 朴素按钮 -通过`plain`属性将按钮设置为朴素按钮，朴素按钮的文字为按钮颜色，背景为白色 +通过`plain`属性将按钮设置为朴素按钮，朴素按钮的文字为按钮颜色，背景为白色。 ```html 朴素按钮 @@ -39,7 +39,7 @@ ### 细边框 -设置`hairline`属性可以开启 0.5px 边框，基于伪类实现 +设置`hairline`属性可以开启 0.5px 边框，基于伪类实现。 ```html 细边框按钮 @@ -48,7 +48,7 @@ ### 禁用状态 -通过`disabled`属性来禁用按钮，此时按钮的`bind:click`事件不会触发 +通过`disabled`属性来禁用按钮，此时按钮的`bind:click`事件不会触发。 ```html 禁用状态 @@ -72,7 +72,7 @@ ### 图标按钮 -通过`icon`属性设置按钮图标，支持 Icon 组件里的所有图标，也可以传入图标 URL +通过`icon`属性设置按钮图标，支持 Icon 组件里的所有图标，也可以传入图标 URL。 ```html @@ -84,7 +84,7 @@ ### 按钮尺寸 -支持`large`、`normal`、`small`、`mini`四种尺寸，默认为`normal` +支持`large`、`normal`、`small`、`mini`四种尺寸，默认为`normal`。 ```html 大号按钮 @@ -95,7 +95,7 @@ ### 块级元素 -通过`block`属性可以将按钮的元素类型设置为块级元素 +通过`block`属性可以将按钮的元素类型设置为块级元素。 ```html 块级元素 @@ -103,7 +103,7 @@ ### 自定义颜色 -通过`color`属性可以自定义按钮的颜色 +通过`color`属性可以自定义按钮的颜色。 ```html 单色按钮 diff --git a/packages/calendar/README.md b/packages/calendar/README.md index 7718742f..a4456cec 100644 --- a/packages/calendar/README.md +++ b/packages/calendar/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -18,7 +18,7 @@ ### 选择单个日期 -下面演示了结合单元格来使用日历组件的用法，日期选择完成后会触发`confirm`事件 +下面演示了结合单元格来使用日历组件的用法，日期选择完成后会触发`confirm`事件。 ```html @@ -130,7 +130,7 @@ Page({ ### 快捷选择 -将`show-confirm`设置为`false`可以隐藏确认按钮，这种情况下选择完成后会立即触发`confirm`事件 +将`show-confirm`设置为`false`可以隐藏确认按钮，这种情况下选择完成后会立即触发`confirm`事件。 ```html @@ -138,7 +138,7 @@ Page({ ### 自定义颜色 -通过`color`属性可以自定义日历的颜色，对选中日期和底部按钮生效 +通过`color`属性可以自定义日历的颜色，对选中日期和底部按钮生效。 ```html @@ -168,7 +168,7 @@ Page({ ### 自定义按钮文字 -通过`confirm-text`设置按钮文字，通过`confirm-disabled-text`设置按钮禁用时的文字 +通过`confirm-text`设置按钮文字，通过`confirm-disabled-text`设置按钮禁用时的文字。 ```html @@ -226,7 +226,7 @@ Page({ ### 日期区间最大范围 -选择日期区间时，可以通过`max-range`属性来指定最多可选天数，选择的范围超过最多可选天数时，会弹出相应的提示文案 +选择日期区间时，可以通过`max-range`属性来指定最多可选天数，选择的范围超过最多可选天数时，会弹出相应的提示文案。 ```html @@ -234,7 +234,7 @@ Page({ ### 平铺展示 -将`poppable`设置为`false`，日历会直接展示在页面内，而不是以弹层的形式出现 +将`poppable`设置为`false`，日历会直接展示在页面内，而不是以弹层的形式出现。 ```html @@ -39,7 +39,7 @@ ### 展示图标 -通过`icon`属性在标题左侧展示图标 +通过`icon`属性在标题左侧展示图标。 ```html @@ -47,7 +47,7 @@ ### 展示箭头 -设置`is-link`属性后会在单元格右侧显示箭头，并且可以通过`arrow-direction`属性控制箭头方向 +设置`is-link`属性后会在单元格右侧显示箭头，并且可以通过`arrow-direction`属性控制箭头方向。 ```html @@ -57,7 +57,7 @@ ### 页面跳转 -可以通过`url`属性进行页面跳转，通过`link-type`属性控制跳转类型 +可以通过`url`属性进行页面跳转，通过`link-type`属性控制跳转类型。 ```html @@ -83,7 +83,7 @@ ### 使用插槽 -如以上用法不能满足你的需求，可以使用插槽来自定义内容 +如以上用法不能满足你的需求，可以使用插槽来自定义内容。 ```html @@ -99,7 +99,7 @@ ### 垂直居中 -通过`center`属性可以让`Cell`的左右内容都垂直居中 +通过`center`属性可以让`Cell`的左右内容都垂直居中。 ```html diff --git a/packages/checkbox/README.md b/packages/checkbox/README.md index 6845e152..67174e23 100644 --- a/packages/checkbox/README.md +++ b/packages/checkbox/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -19,7 +19,7 @@ ### 基础用法 -通过`value`绑定复选框的勾选状态 +通过`value`绑定复选框的勾选状态。 ```html 复选框 @@ -41,7 +41,7 @@ Page({ ### 禁用状态 -通过设置`disabled`属性可以禁用复选框 +通过设置`disabled`属性可以禁用复选框。 ```html @@ -51,7 +51,7 @@ Page({ ### 自定义形状 -将`shape`属性设置为`square`，复选框的形状会变成方形 +将`shape`属性设置为`square`，复选框的形状会变成方形。 ```html @@ -61,7 +61,7 @@ Page({ ### 自定义颜色 -通过`checked-color`属性可以自定义选中状态下的图标颜色 +通过`checked-color`属性可以自定义选中状态下的图标颜色。 ```html 复选框 @@ -83,7 +83,7 @@ Page({ ### 自定义图标 -通过 icon 插槽自定义图标 +通过 icon 插槽自定义图标。 ```html @@ -110,7 +110,7 @@ Page({ ### 禁用文本点击 -通过设置`label-disabled`属性可以禁用复选框文本点击 +通过设置`label-disabled`属性可以禁用复选框文本点击。 ```html 复选框 @@ -118,7 +118,7 @@ Page({ ### 复选框组 -需要与`van-checkbox-group`一起使用，选中值是一个数组，通过`value`绑定在`van-checkbox-group`上，数组中的项即为选中的`Checkbox`的`name`属性设置的值 +需要与`van-checkbox-group`一起使用，选中值是一个数组，通过`value`绑定在`van-checkbox-group`上，数组中的项即为选中的`Checkbox`的`name`属性设置的值。 ```html @@ -154,7 +154,7 @@ Page({ ### 搭配单元格组件使用 -此时你需要再引入`Cell`和`CellGroup`组件，并通过 checkbox 的 toggle 方法手动触发切换 +此时你需要再引入`Cell`和`CellGroup`组件，并通过 checkbox 的 toggle 方法手动触发切换。 ```html @@ -261,7 +261,7 @@ Page({ ### Checkbox 方法 -通过 selectComponent 可以获取到 checkbox 实例并调用实例方法 +通过 selectComponent 可以获取到 checkbox 实例并调用实例方法。 | 方法名 | 参数 | 返回值 | 介绍 | | ------ | ---- | ------ | ------------ | diff --git a/packages/circle/README.md b/packages/circle/README.md index ce23207a..a90b8ca7 100644 --- a/packages/circle/README.md +++ b/packages/circle/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -26,7 +26,7 @@ ### 宽度定制 -通过`stroke-width`属性来控制进度条宽度 +通过`stroke-width`属性来控制进度条宽度。 ```html @@ -34,7 +34,7 @@ ### 颜色定制 -通过`color`属性来控制进度条颜色，`layer-color`属性来控制轨道颜色 +通过`color`属性来控制进度条颜色，`layer-color`属性来控制轨道颜色。 ```html @@ -67,7 +67,7 @@ Page({ ### 逆时针方向 -将`clockwise`设置为`false`，进度会从逆时针方向开始 +将`clockwise`设置为`false`，进度会从逆时针方向开始。 ```html diff --git a/packages/col/README.md b/packages/col/README.md index 223066bd..6fe1d788 100644 --- a/packages/col/README.md +++ b/packages/col/README.md @@ -2,11 +2,11 @@ ### 介绍 -Layout 提供了`van-row`和`van-col`两个组件来进行行列布局 +Layout 提供了`van-row`和`van-col`两个组件来进行行列布局。 ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -19,7 +19,7 @@ Layout 提供了`van-row`和`van-col`两个组件来进行行列布局 ### 基本用法 -Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置列所占的宽度百分比。此外，添加`offset`属性可以设置列的偏移宽度，计算方式与 span 相同 +Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置列所占的宽度百分比。此外，添加`offset`属性可以设置列的偏移宽度，计算方式与 span 相同。 ```html @@ -40,7 +40,7 @@ Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置 ### 设置列元素间距 -通过`gutter`属性可以设置列元素之间的间距，默认间距为 0 +通过`gutter`属性可以设置列元素之间的间距，默认间距为0。 ```html diff --git a/packages/collapse/README.md b/packages/collapse/README.md index cc6c3cb0..818152ab 100644 --- a/packages/collapse/README.md +++ b/packages/collapse/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -19,7 +19,7 @@ ### 基础用法 -通过`value`控制展开的面板列表，`activeNames`为数组格式 +通过`value`控制展开的面板列表，`activeNames`为数组格式。 ```html @@ -50,7 +50,7 @@ Page({ ### 手风琴 -通过`accordion`可以设置为手风琴模式，最多展开一个面板，此时`activeName`为字符串格式 +通过`accordion`可以设置为手风琴模式，最多展开一个面板，此时`activeName`为字符串格式。 ```html diff --git a/packages/common/README.md b/packages/common/README.md index d5c2577b..14ac25a4 100644 --- a/packages/common/README.md +++ b/packages/common/README.md @@ -6,7 +6,7 @@ Vant 中默认包含了一些常用样式，可以直接通过 className 的方 ### 引入 -在 app.wxss 中引入内置样式 +在 app.wxss 中引入内置样式。 ```css @import '@vant/weapp/common/index.wxss'; @@ -20,17 +20,17 @@ Vant 中默认包含了一些常用样式，可以直接通过 className 的方 ```xml - 这是一段宽度限制 250px 的文字，后面的内容会省略 + 这是一段宽度限制 250px 的文字，后面的内容会省略。 - 这是一段最多显示两行的文字，后面的内容会省略 + 这是一段最多显示两行的文字，后面的内容会省略。 - 这是一段最多显示三行的文字，后面的内容会省略 + 这是一段最多显示三行的文字，后面的内容会省略。 ``` diff --git a/packages/count-down/README.md b/packages/count-down/README.md index 483d379a..2bcae1e0 100644 --- a/packages/count-down/README.md +++ b/packages/count-down/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -14,13 +14,13 @@ } ``` -> Vant Weapp 1.0 版本开始支持此组件，升级方式参见[快速上手](#/quickstart) +> Vant Weapp 1.0 版本开始支持此组件，升级方式参见[快速上手](#/quickstart)。 ## 代码演示 ### 基本用法 -`time`属性表示倒计时总时长，单位为毫秒 +`time`属性表示倒计时总时长，单位为毫秒。 ```html @@ -36,7 +36,7 @@ Page({ ### 自定义格式 -通过`format`属性设置倒计时文本的内容 +通过`format`属性设置倒计时文本的内容。 ```html @@ -44,7 +44,7 @@ Page({ ### 毫秒级渲染 -倒计时默认每秒渲染一次，设置`millisecond`属性可以开启毫秒级渲染 +倒计时默认每秒渲染一次，设置`millisecond`属性可以开启毫秒级渲染。 ```html @@ -52,7 +52,7 @@ Page({ ### 自定义样式 -设置`use-slot`属性后可以自定义倒计时样式，需要通过`bind:change`事件获取`timeData`对象并自行渲染，格式见下方表格 +设置`use-slot`属性后可以自定义倒计时样式，需要通过`bind:change`事件获取`timeData`对象并自行渲染，格式见下方表格。 ```html @@ -92,7 +92,7 @@ Page({ ### 手动控制 -通过 `selectComponent` 选择器获取到组件实例后，可以调用`start`、`pause`、`reset`方法 +通过 `selectComponent` 选择器获取到组件实例后，可以调用`start`、`pause`、`reset`方法。 ```html @@ -43,7 +43,7 @@ Dialog.alert({ ### 消息确认 -用于确认消息，包含取消和确认按钮 +用于确认消息，包含取消和确认按钮。 ```html diff --git a/packages/divider/README.md b/packages/divider/README.md index 679b8fa6..72a02d33 100644 --- a/packages/divider/README.md +++ b/packages/divider/README.md @@ -14,7 +14,7 @@ } ``` -> Vant Weapp 1.0 版本开始支持此组件，升级方式参见[快速上手](#/quickstart) +> Vant Weapp 1.0 版本开始支持此组件，升级方式参见[快速上手](#/quickstart)。 ## 代码演示 diff --git a/packages/dropdown-menu/README.md b/packages/dropdown-menu/README.md index 4cb87dd4..967110af 100644 --- a/packages/dropdown-menu/README.md +++ b/packages/dropdown-menu/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart) +在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart)。 ```json "usingComponents": { @@ -172,7 +172,7 @@ Page({ ### DropdownItem 方法 -通过 selectComponent(id) 可访问 +通过 selectComponent(id) 可访问。 | 方法名 | 说明 | 参数 | 返回值 | | --- | --- | --- | --- | diff --git a/packages/empty/README.md b/packages/empty/README.md index 4a64abd9..1d7c564b 100644 --- a/packages/empty/README.md +++ b/packages/empty/README.md @@ -2,11 +2,11 @@ ### 介绍 -空状态时的占位提示 +空状态时的占位提示。 ### 引入 -在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart) +在`app.json`或`index.json`中引入组件，默认为`ES6`版本，`ES5`引入方式参见[快速上手](#/quickstart)。 ```json "usingComponents": { @@ -24,7 +24,7 @@ ### 图片类型 -Empty 组件内置了多种占位图片类型，可以在不同业务场景下使用 +Empty 组件内置了多种占位图片类型，可以在不同业务场景下使用。 ```html @@ -37,7 +37,7 @@ Empty 组件内置了多种占位图片类型，可以在不同业务场景下 ### 自定义图片 -需要自定义图片时，可以在 image 属性中传入任意图片 URL +需要自定义图片时，可以在 image 属性中传入任意图片 URL。 ```html diff --git a/packages/field/README.md b/packages/field/README.md index 068c75d2..ffb77032 100644 --- a/packages/field/README.md +++ b/packages/field/README.md @@ -2,11 +2,11 @@ ### 介绍 -表单中的输入框组件 +用户可以在文本框内输入或编辑文字。 ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -44,7 +44,7 @@ Page({ ### 双向绑定 -最低基础库版本在 2.9.3 以上时，可以使用[简易双向绑定](https://developers.weixin.qq.com/miniprogram/dev/framework/view/two-way-bindings.html) +最低基础库版本在 2.9.3 以上时，可以使用[简易双向绑定](https://developers.weixin.qq.com/miniprogram/dev/framework/view/two-way-bindings.html)。 ```html @@ -66,7 +66,7 @@ Page({ ### 自定义类型 -根据`type`属性定义不同类型的输入框 +根据`type`属性定义不同类型的输入框。 ```html @@ -107,7 +107,7 @@ Page({ ### 错误提示 -通过`error`或者`error-message`属性增加对应的错误提示 +通过`error`或者`error-message`属性增加对应的错误提示。 ```html @@ -129,7 +129,7 @@ Page({ ### 内容对齐方式 -可以通过`input-align`属性设置内容的对齐方式 +可以通过`input-align`属性设置内容的对齐方式。 ```html @@ -144,7 +144,7 @@ Page({ ### 高度自适应 -对于 textarea，可以通过`autosize`属性设置高度自适应 +对于 textarea，可以通过`autosize`属性设置高度自适应。 ```html @@ -161,7 +161,7 @@ Page({ ### 插入按钮 -通过 button slot 可以在输入框尾部插入按钮 +通过 button slot 可以在输入框尾部插入按钮。 ```html @@ -187,11 +187,11 @@ Page({ 由于微信小程序的 input 组件和 textarea 组件是原生组件，聚焦时会将原生的输入框覆盖在对应位置上，导致了这个现象的产生。 -相关的讨论可以查看[微信开放社区](https://developers.weixin.qq.com/community/search?query=placeholder%20%E9%97%AA%E7%83%81%20%E5%8A%A0%E7%B2%97) +相关的讨论可以查看[微信开放社区](https://developers.weixin.qq.com/community/search?query=placeholder%20%E9%97%AA%E7%83%81%20%E5%8A%A0%E7%B2%97)。 ### 真机上 placeholder 为什么会盖过 popup 等其它组件？ -由于微信小程序的 input 组件和 textarea 组件是原生组件，遵循原生组件的限制，详情可以查看[原生组件说明](https://developers.weixin.qq.com/miniprogram/dev/component/native-component.html) +由于微信小程序的 input 组件和 textarea 组件是原生组件，遵循原生组件的限制，详情可以查看[原生组件说明](https://developers.weixin.qq.com/miniprogram/dev/component/native-component.html)。 ### textarea 的 placeholder 在真机上为什么会偏移？ @@ -201,13 +201,13 @@ Page({ 这一系列的问题导致了 placeholder 在真机上可能会出现偏移。 -微信已经在 `2.10.0` 基础库版本后支持移除默认的 `padding`，但低版本仍有问题。详情可以查看 [微信开放社区](https://developers.weixin.qq.com/community/develop/issue/96) +微信已经在 `2.10.0` 基础库版本后支持移除默认的 `padding`，但低版本仍有问题。详情可以查看 [微信开放社区](https://developers.weixin.qq.com/community/develop/issue/96)。 ### 手写输入法为什么会丢失部分字符 / 手写输入法为什么不会触发 input 事件？ 这是微信小程序的 input 组件本身的问题，如果需要兼容手写输入法的场景，可以在 `blur` 事件中取到输入的值。 -相关的讨论可以查看[微信开放社区](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) +相关的讨论可以查看[微信开放社区](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 diff --git a/packages/goods-action/README.md b/packages/goods-action/README.md index ebb19f34..48967866 100644 --- a/packages/goods-action/README.md +++ b/packages/goods-action/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -16,7 +16,7 @@ } ``` -> Vant Weapp 1.0 版本开始支持此组件，升级方式参见[快速上手](#/quickstart) +> Vant Weapp 1.0 版本开始支持此组件，升级方式参见[快速上手](#/quickstart)。 ## 代码演示 @@ -49,7 +49,7 @@ Page({ ### 提示信息 -设置`dot`属性后，会在图标右上角展示一个小红点。设置`info`属性后，会在图标右上角展示相应的徽标 +设置`dot`属性后，会在图标右上角展示一个小红点。设置`info`属性后，会在图标右上角展示相应的徽标。 ```html @@ -63,7 +63,7 @@ Page({ ### 自定义按钮颜色 -通过`color`属性可以自定义按钮的颜色，支持传入`linear-gradient`渐变色 +通过`color`属性可以自定义按钮的颜色，支持传入`linear-gradient`渐变色。 ```html @@ -77,7 +77,7 @@ Page({ ### 朴素按钮 -通过`plain`属性将按钮设置为朴素按钮，朴素按钮的文字为按钮颜色，背景为白色 +通过`plain`属性将按钮设置为朴素按钮，朴素按钮的文字为按钮颜色，背景为白色。 ```html diff --git a/packages/grid/README.md b/packages/grid/README.md index 03bf740b..b63079f0 100644 --- a/packages/grid/README.md +++ b/packages/grid/README.md @@ -2,11 +2,11 @@ ### 介绍 -宫格可以在水平方向上把页面分隔成等宽度的区块，用于展示内容或进行页面导航 +宫格可以在水平方向上把页面分隔成等宽度的区块，用于展示内容或进行页面导航。 ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -21,7 +21,7 @@ ### 基本用法 -通过`icon`属性设置格子内的图标，`text`属性设置文字内容 +通过`icon`属性设置格子内的图标，`text`属性设置文字内容。 ```html @@ -34,7 +34,7 @@ ### 自定义列数 -默认一行展示四个格子，可以通过`column-num`自定义列数 +默认一行展示四个格子，可以通过`column-num`自定义列数。 ```html @@ -44,7 +44,7 @@ ### 自定义内容 -通过插槽可以自定义格子展示的内容 +通过插槽可以自定义格子展示的内容。 ```html @@ -59,7 +59,7 @@ ### 正方形格子 -设置`square`属性后，格子的高度会和宽度保持一致 +设置`square`属性后，格子的高度会和宽度保持一致。 ```html @@ -69,7 +69,7 @@ ### 格子间距 -通过`gutter`属性设置格子之间的距离 +通过`gutter`属性设置格子之间的距离。 ```html @@ -79,7 +79,7 @@ ### 内容横排 -将`direction`属性设置为`horizontal`，可以让宫格的内容呈横向排列 +将`direction`属性设置为`horizontal`，可以让宫格的内容呈横向排列。 ```html @@ -91,7 +91,7 @@ ### 页面跳转 -可以通过`url`属性进行页面跳转，通过`link-type`属性控制跳转类型 +可以通过`url`属性进行页面跳转，通过`link-type`属性控制跳转类型。 ```html @@ -112,7 +112,7 @@ ### 提示信息 -设置`dot`属性后，会在图标右上角展示一个小红点。设置`badge`属性后，会在图标右上角展示相应的徽标 +设置`dot`属性后，会在图标右上角展示一个小红点。设置`badge`属性后，会在图标右上角展示相应的徽标。 ```html diff --git a/packages/icon/README.md b/packages/icon/README.md index baefbd3c..11ee0d1a 100644 --- a/packages/icon/README.md +++ b/packages/icon/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -18,7 +18,7 @@ ### 基础用法 -`Icon`的`name`属性支持传入图标名称或图片链接 +`Icon`的`name`属性支持传入图标名称或图片链接。 ```html @@ -27,7 +27,7 @@ ### 提示信息 -设置`dot`属性后，会在图标右上角展示一个小红点。设置`info`属性后，会在图标右上角展示相应的徽标 +设置`dot`属性后，会在图标右上角展示一个小红点。设置`info`属性后，会在图标右上角展示相应的徽标。 ```html @@ -37,7 +37,7 @@ ### 图标颜色 -设置`color`属性来控制图标颜色 +设置`color`属性来控制图标颜色。 ```html @@ -45,7 +45,7 @@ ### 图标大小 -设置`size`属性来控制图标大小 +设置`size`属性来控制图标大小。 ```html @@ -55,7 +55,7 @@ ### 开发者工具上提示 Faild to load font 是什么情况？ -这个是开发者工具本身的问题，可以忽略，具体可以查看[微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/font/wx.loadFontFace.html)注意第 5 条 +这个是开发者工具本身的问题，可以忽略，具体可以查看[微信小程序文档](https://developers.weixin.qq.com/miniprogram/dev/api/ui/font/wx.loadFontFace.html)注意第5条。 ## API diff --git a/packages/image/README.md b/packages/image/README.md index 50c1081a..370ce174 100644 --- a/packages/image/README.md +++ b/packages/image/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -14,13 +14,13 @@ } ``` -> Vant Weapp 1.0 版本开始支持此组件，升级方式参见[快速上手](#/quickstart) +> Vant Weapp 1.0 版本开始支持此组件，升级方式参见[快速上手](#/quickstart)。 ## 代码演示 ### 基础用法 -基础用法与原生 [image](<(https://developers.weixin.qq.com/miniprogram/dev/component/image.html)>) 标签一致，可以设置`src`、`width`、`height`等原生属性 +基础用法与原生 [image](<(https://developers.weixin.qq.com/miniprogram/dev/component/image.html)>) 标签一致，可以设置`src`、`width`、`height`等原生属性。 ```html @@ -28,7 +28,7 @@ ### 填充模式 -通过`fit`属性可以设置图片填充模式，可选值见下方表格 +通过`fit`属性可以设置图片填充模式，可选值见下方表格。 ```html @@ -77,7 +77,7 @@ ### 加载失败提示 -`Image`组件提供了默认的加载失败提示，支持通过`error`插槽自定义内容 +`Image`组件提供了默认的加载失败提示，支持通过`error`插槽自定义内容。 ```html diff --git a/packages/index-bar/README.md b/packages/index-bar/README.md index 0289e677..1cdd296f 100644 --- a/packages/index-bar/README.md +++ b/packages/index-bar/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -21,7 +21,7 @@ ### 基础用法 -点击索引栏时，会自动跳转到对应的`IndexAnchor`锚点位置 +点击索引栏时，会自动跳转到对应的`IndexAnchor`锚点位置。 ```html @@ -45,7 +45,7 @@ ### 自定义索引列表 -可以通过`index-list`属性自定义展示的索引字符列表， +可以通过`index-list`属性自定义展示的索引字符列表。 ```html diff --git a/packages/loading/README.md b/packages/loading/README.md index a52ffab7..a6a3553a 100644 --- a/packages/loading/README.md +++ b/packages/loading/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { diff --git a/packages/nav-bar/README.md b/packages/nav-bar/README.md index ed8419fc..7e430481 100644 --- a/packages/nav-bar/README.md +++ b/packages/nav-bar/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -42,7 +42,7 @@ Page({ ### 高级用法 -通过 slot 定制内容 +通过 slot 定制内容。 ```html diff --git a/packages/notice-bar/README.md b/packages/notice-bar/README.md index 6f8868c3..8fc74ce6 100644 --- a/packages/notice-bar/README.md +++ b/packages/notice-bar/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -79,7 +79,7 @@ ### 自定义滚动速率 -使用`speed`属性控制滚动速率 +使用`speed`属性控制滚动速率。 ```html 嵌入内容 diff --git a/packages/panel/README.md b/packages/panel/README.md index 89bc6aa4..0edf10f2 100644 --- a/packages/panel/README.md +++ b/packages/panel/README.md @@ -2,7 +2,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -14,7 +14,7 @@ ### 基础用法 -面板只是一个容器，里面可以放入自定义的内容 +面板只是一个容器，里面可以放入自定义的内容。 ```html @@ -24,7 +24,7 @@ ### 高级用法 -使用`slot`自定义内容 +使用`slot`自定义内容。 ```html diff --git a/packages/picker/README.md b/packages/picker/README.md index 47333d0e..fe661243 100644 --- a/packages/picker/README.md +++ b/packages/picker/README.md @@ -2,11 +2,11 @@ ### 介绍 -选择器组件通常与 [弹出层](#/popup) 组件配合使用 +提供多个选项集合供用户选择，支持单列选择和多列级联，通常与 [弹出层](#/popup) 组件配合使用。 ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -39,7 +39,7 @@ Page({ ### 默认选中项 -单列选择器可以直接通过`default-index`属性设置初始选中项的索引值 +单列选择器可以直接通过`default-index`属性设置初始选中项的索引值。 ```html @@ -136,7 +136,7 @@ Page({ ### 加载状态 -当 Picker 数据是通过异步获取时，可以通过 `loading` 属性显示加载提示 +当 Picker 数据是通过异步获取时，可以通过 `loading` 属性显示加载提示。 ```html @@ -162,7 +162,7 @@ Page({ ### Events -Picker 组件的事件会根据 columns 是单列或多列返回不同的参数 +Picker 组件的事件会根据 columns 是单列或多列返回不同的参数。 | 事件名 | 说明 | 参数 | | --- | --- | --- | @@ -172,7 +172,7 @@ Picker 组件的事件会根据 columns 是单列或多列返回不同的参数 ### Columns 数据结构 -当传入多列数据时，`columns`为一个对象数组，数组中的每一个对象配置每一列，每一列有以下`key` +当传入多列数据时，`columns`为一个对象数组，数组中的每一个对象配置每一列，每一列有以下`key`。 | key | 说明 | | ------------ | -------------------------- | @@ -190,7 +190,7 @@ Picker 组件的事件会根据 columns 是单列或多列返回不同的参数 ### 方法 -通过 selectComponent 可以获取到 picker 实例并调用实例方法 +通过 selectComponent 可以获取到 picker 实例并调用实例方法。 | 方法名 | 参数 | 返回值 | 介绍 | | --- | --- | --- | --- | diff --git a/packages/popup/README.md b/packages/popup/README.md index 38b791d5..4a818244 100644 --- a/packages/popup/README.md +++ b/packages/popup/README.md @@ -2,11 +2,11 @@ ### 介绍 -弹出层容器，用于展示弹窗、信息提示等内容，支持多个弹出层叠加展示 +弹出层容器，用于展示弹窗、信息提示等内容，支持多个弹出层叠加展示。 ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -18,7 +18,7 @@ ### 基础用法 -通过`show`属性控制弹出层是否展示 +通过`show`属性控制弹出层是否展示。 ```html @@ -44,7 +44,7 @@ Page({ ### 弹出位置 -通过`position`属性设置弹出位置，默认居中弹出，可以设置为`top`、`bottom`、`left`、`right` +通过`position`属性设置弹出位置，默认居中弹出，可以设置为`top`、`bottom`、`left`、`right`。 ```html @@ -26,7 +26,7 @@ ### 线条粗细 -通过`stroke-width`可以设置进度条的粗细 +通过`stroke-width`可以设置进度条的粗细。 ```html @@ -42,7 +42,7 @@ ### 样式定制 -可以使用`pivot-text`属性自定义文字，`color`属性自定义进度条颜色 +可以使用`pivot-text`属性自定义文字，`color`属性自定义进度条颜色。 ```html diff --git a/packages/radio/README.md b/packages/radio/README.md index c9d8dfa0..3b7be1c0 100644 --- a/packages/radio/README.md +++ b/packages/radio/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -19,7 +19,7 @@ ### 基础用法 -通过`value`绑定值当前选中项的 name +通过`value`绑定值当前选中项的 name 。 ```html @@ -59,7 +59,7 @@ Page({ ### 禁用状态 -通过`disabled`属性禁止选项切换，在`Radio`上设置`diabled`可以禁用单个选项 +通过`disabled`属性禁止选项切换，在`Radio`上设置`diabled`可以禁用单个选项。 ```html @@ -70,7 +70,7 @@ Page({ ### 自定义形状 -将`shape`属性设置为`square`，单选框的形状会变成方形 +将`shape`属性设置为`square`，单选框的形状会变成方形。 ```html @@ -81,7 +81,7 @@ Page({ ### 自定义颜色 -通过`checked-color`属性设置选中状态的图标颜色 +通过`checked-color`属性设置选中状态的图标颜色。 ```html @@ -92,7 +92,7 @@ Page({ ### 自定义大小 -通过`icon-size`属性可以自定义图标的大小 +通过`icon-size`属性可以自定义图标的大小。 ```html @@ -103,7 +103,7 @@ Page({ ### 自定义图标 -通过`icon`插槽自定义图标，需要设置`use-icon-slot`属性 +通过`icon`插槽自定义图标，需要设置`use-icon-slot`属性。 ```html @@ -137,7 +137,7 @@ Page({ ### 禁用文本点击 -通过设置`label-disabled`属性可以禁用单选框文本点击 +通过设置`label-disabled`属性可以禁用单选框文本点击。 ```html diff --git a/packages/rate/README.md b/packages/rate/README.md index c40af59e..582766a7 100644 --- a/packages/rate/README.md +++ b/packages/rate/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { diff --git a/packages/search/README.md b/packages/search/README.md index a87db042..9439f865 100644 --- a/packages/search/README.md +++ b/packages/search/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -26,7 +26,7 @@ ### 事件监听 -`van-search` 提供了 search 和 cancel 事件。search 事件在用户点击键盘上的搜索按钮触发。cancel 事件在用户点击搜索框右侧取消按钮时触发 +`van-search` 提供了 search 和 cancel 事件。search 事件在用户点击键盘上的搜索按钮触发。cancel 事件在用户点击搜索框右侧取消按钮时触发。 ```html @@ -60,7 +60,7 @@ ### 自定义背景色 -通过`background`属性可以设置搜索框外部的背景色，通过`shape`属性设置搜索框的形状，可选值为`round` +通过`background`属性可以设置搜索框外部的背景色，通过`shape`属性设置搜索框的形状，可选值为`round`。 ```html @@ -41,7 +41,7 @@ Page({ ### 徽标提示 -设置`dot`属性后，会在右上角展示一个小红点。设置`badge`属性后，会在右上角展示相应的徽标 +设置`dot`属性后，会在右上角展示一个小红点。设置`badge`属性后，会在右上角展示相应的徽标。 ```html @@ -53,7 +53,7 @@ Page({ ### 禁用选项 -通过`disabled`属性禁用选项 +通过`disabled`属性禁用选项。 ```html @@ -65,7 +65,7 @@ Page({ ### 监听切换事件 -设置`change`方法来监听切换导航项时的事件 +设置`change`方法来监听切换导航项时的事件。 ```html diff --git a/packages/skeleton/README.md b/packages/skeleton/README.md index 3da24c65..10d5b667 100644 --- a/packages/skeleton/README.md +++ b/packages/skeleton/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -20,7 +20,7 @@ ### 基础用法 -通过`title`属性显示标题占位图，通过`row`属性配置占位段落行数 +通过`title`属性显示标题占位图，通过`row`属性配置占位段落行数。 ```html @@ -28,7 +28,7 @@ ### 显示头像 -通过`avatar`属性显示头像占位图 +通过`avatar`属性显示头像占位图。 ```html @@ -36,7 +36,7 @@ ### 展示子组件 -将`loading`属性设置成`false`表示内容加载完成，此时会隐藏占位图，并显示`Skeleton`的子组件 +将`loading`属性设置成`false`表示内容加载完成，此时会隐藏占位图，并显示`Skeleton`的子组件。 ```html diff --git a/packages/slider/README.md b/packages/slider/README.md index eccc9bf9..45dbfc1b 100644 --- a/packages/slider/README.md +++ b/packages/slider/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { diff --git a/packages/stepper/README.md b/packages/stepper/README.md index 9cfe6bdf..1359fc0c 100644 --- a/packages/stepper/README.md +++ b/packages/stepper/README.md @@ -2,11 +2,11 @@ ### 介绍 -步进器由增加按钮、减少按钮和输入框组成，用于在一定范围内输入、调整数字 +步进器由增加按钮、减少按钮和输入框组成，用于在一定范围内输入、调整数字。 ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -18,7 +18,7 @@ ### 基础用法 -通过`value`设置输入值，可以通过`change`事件监听到输入值的变化 +通过`value`设置输入值，可以通过`change`事件监听到输入值的变化。 ```html @@ -34,7 +34,7 @@ Page({ ### 步长设置 -通过`step`属性设置每次点击增加或减少按钮时变化的值，默认为`1` +通过`step`属性设置每次点击增加或减少按钮时变化的值，默认为`1`。 ```html @@ -42,7 +42,7 @@ Page({ ### 限制输入范围 -通过`min`和`max`属性限制输入值的范围 +通过`min`和`max`属性限制输入值的范围。 ```html @@ -50,7 +50,7 @@ Page({ ### 限制输入整数 -设置`integer`属性后，输入框将限制只能输入整数 +设置`integer`属性后，输入框将限制只能输入整数。 ```html @@ -58,7 +58,7 @@ Page({ ### 禁用状态 -通过设置`disabled`属性来禁用步进器，禁用状态下无法点击按钮或修改输入框 +通过设置`disabled`属性来禁用步进器，禁用状态下无法点击按钮或修改输入框。 ```html @@ -66,7 +66,7 @@ Page({ ### 关闭长按 -通过设置`long-press`属性决定步进器是否开启长按手势 +通过设置`long-press`属性决定步进器是否开启长按手势。 ```html @@ -74,7 +74,7 @@ Page({ ### 固定小数位数 -通过设置`decimal-length`属性可以保留固定的小数位数 +通过设置`decimal-length`属性可以保留固定的小数位数。 ```html @@ -82,7 +82,7 @@ Page({ ### 异步变更 -如果需要异步地修改输入框的值，可以设置`async-change`属性，并在`change`事件中手动修改`value` +如果需要异步地修改输入框的值，可以设置`async-change`属性，并在`change`事件中手动修改`value`。 ```html @@ -107,7 +107,7 @@ Page({ ### 自定义大小 -通过`input-width`属性设置输入框宽度，通过`button-size`属性设置按钮大小和输入框高度 +通过`input-width`属性设置输入框宽度，通过`button-size`属性设置按钮大小和输入框高度。 ```html diff --git a/packages/steps/README.md b/packages/steps/README.md index 257461b6..6b5609f8 100644 --- a/packages/steps/README.md +++ b/packages/steps/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -49,7 +49,7 @@ Page({ ### 自定义样式 -可以通过 `active-icon` 和 `active-color` 属性设置激活状态下的图标和颜色 +可以通过 `active-icon` 和 `active-color` 属性设置激活状态下的图标和颜色。 ```html @@ -103,7 +103,7 @@ Page({ ### 竖向步骤条 -可以通过设置`direction`属性来改变步骤条的显示方式 +可以通过设置`direction`属性来改变步骤条的显示方式。 ```html @@ -30,7 +30,7 @@ Sticky 组件与 CSS 中`position: sticky`属性实现的效果一致，当组 ### 吸顶距离 -通过`offset-top`属性可以设置组件在吸顶时与顶部的距离 +通过`offset-top`属性可以设置组件在吸顶时与顶部的距离。 ```html @@ -40,7 +40,7 @@ Sticky 组件与 CSS 中`position: sticky`属性实现的效果一致，当组 ### 指定容器 -通过`container`属性可以指定组件的容器，页面滚动时，组件会始终保持在容器范围内，当组件即将超出容器底部时，会返回原位置 +通过`container`属性可以指定组件的容器，页面滚动时，组件会始终保持在容器范围内，当组件即将超出容器底部时，会返回原位置。 ```html @@ -68,7 +68,7 @@ Page({ ### 嵌套在 scroll-view 内使用 -通过 `scroll-top` 与 `offset-top` 属性可以实现在 scroll-view 内嵌套使用 +通过 `scroll-top` 与 `offset-top` 属性可以实现在 scroll-view 内嵌套使用。 ```html @@ -47,7 +47,7 @@ Page({ ### 通过名称匹配 -在标签指定`name`属性的情况下，`active`的值为当前标签的`name`（此时无法通过索引值来匹配标签） +在标签指定`name`属性的情况下，`active`的值为当前标签的`name`（此时无法通过索引值来匹配标签）。 ```html @@ -59,7 +59,7 @@ Page({ ### 横向滚动 -多于 5 个标签时，Tab 可以横向滚动 +多于 5 个标签时，Tab 可以横向滚动。 ```html @@ -74,7 +74,7 @@ Page({ ### 禁用标签 -设置`disabled`属性即可禁用标签。如果需要监听禁用标签的点击事件，可以在`van-tabs`上监听`disabled`事件 +设置`disabled`属性即可禁用标签。如果需要监听禁用标签的点击事件，可以在`van-tabs`上监听`disabled`事件。 ```html @@ -97,7 +97,7 @@ Page({ ### 样式风格 -`Tab`支持两种样式风格：`line`和`card`，默认为`line`样式，可以通过`type`属性修改样式风格 +`Tab`支持两种样式风格：`line`和`card`，默认为`line`样式，可以通过`type`属性修改样式风格。 ```html @@ -109,7 +109,7 @@ Page({ ### 点击事件 -可以在`van-tabs`上绑定`click`事件，在回调参数的`event.detail`中可以取得被点击标签的标题和标识符 +可以在`van-tabs`上绑定`click`事件，在回调参数的`event.detail`中可以取得被点击标签的标题和标识符。 ```html @@ -131,7 +131,7 @@ Page({ ### 粘性布局 -通过`sticky`属性可以开启粘性布局，粘性布局下，当 Tab 滚动到顶部时会自动吸顶 +通过`sticky`属性可以开启粘性布局，粘性布局下，当 Tab 滚动到顶部时会自动吸顶。 ```html @@ -157,7 +157,7 @@ Page({ ### 滑动切换 -通过`swipeable`属性可以开启滑动切换标签页 +通过`swipeable`属性可以开启滑动切换标签页。 ```html @@ -193,13 +193,13 @@ Tabs 组件在挂载时，会获取自身的宽度，并计算出底部条的位 #### 解决方法 -方法一，使用 `wx:if` 来控制组件展示，使组件重新初始化： +方法一，使用 `wx:if` 来控制组件展示，使组件重新初始化。 ```html ``` -方法二，调用组件的 resize 方法来主动触发重绘： +方法二，调用组件的 resize 方法来主动触发重绘。 ```html @@ -277,7 +277,7 @@ this.selectComponent('#tabs').resize(); ### 方法 -通过 selectComponent 可以获取到 Tabs 实例并调用实例方法 +通过 selectComponent 可以获取到 Tabs 实例并调用实例方法。 | 方法名 | 参数 | 返回值 | 介绍 | | --- | --- | --- | --- | diff --git a/packages/tabbar/README.md b/packages/tabbar/README.md index 03435352..64dc4e2c 100644 --- a/packages/tabbar/README.md +++ b/packages/tabbar/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -42,7 +42,7 @@ Page({ ### 通过名称匹配 -在标签指定`name`属性的情况下，`v-model`的值为当前标签的`name` +在标签指定`name`属性的情况下，`v-model`的值为当前标签的`name`。 ```html @@ -77,7 +77,7 @@ Page({ ### 自定义图标 -可以通过 slot 自定义图标，其中 icon slot 代表未选中状态下的图标，icon-active slot 代表选中状态下的图标 +可以通过 slot 自定义图标，其中 icon slot 代表未选中状态下的图标，icon-active slot 代表选中状态下的图标。 ```html @@ -170,7 +170,7 @@ Page({ ### 结合自定义 tabBar -请参考 [微信官方文档](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/custom-tabbar.html) 与 [代码片段](https://developers.weixin.qq.com/s/vaXgTsmQ7hnm) +请参考 [微信官方文档](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/custom-tabbar.html) 与 [代码片段](https://developers.weixin.qq.com/s/vaXgTsmQ7hnm)。 ## API diff --git a/packages/tag/README.md b/packages/tag/README.md index c8500477..c61979ae 100644 --- a/packages/tag/README.md +++ b/packages/tag/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { diff --git a/packages/toast/README.md b/packages/toast/README.md index 3d2038db..9f96c90a 100644 --- a/packages/toast/README.md +++ b/packages/toast/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { diff --git a/packages/transition/README.md b/packages/transition/README.md index 54a6b8b2..39675257 100644 --- a/packages/transition/README.md +++ b/packages/transition/README.md @@ -6,7 +6,7 @@ ### 引入 -在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) +在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。 ```json "usingComponents": { @@ -18,7 +18,7 @@ ### 基础用法 -将元素包裹在 transition 组件内，在元素展示/隐藏时，会有相应的过渡动画 +将元素包裹在 transition 组件内，在元素展示/隐藏时，会有相应的过渡动画。 ```html @@ -28,7 +28,7 @@ ### 动画类型 -transition 组件内置了多种动画，可以通过`name`字段指定动画类型 +transition 组件内置了多种动画，可以通过`name`字段指定动画类型。 ```html @@ -36,7 +36,7 @@ transition 组件内置了多种动画，可以通过`name`字段指定动画类 ### 高级用法 -可以通过外部样式类自定义过渡效果，还可以定制进入和移出的持续时间： +可以通过外部样式类自定义过渡效果，还可以定制进入和移出的持续时间。 ```html @@ -108,7 +108,7 @@ Page({ ### 上传状态 -通过`status`属性可以标识上传状态，`uploading`表示上传中，`failed`表示上传失败，`done`表示上传完成 +通过`status`属性可以标识上传状态，`uploading`表示上传中，`failed`表示上传失败，`done`表示上传完成。 ```html @@ -135,7 +135,7 @@ Page({ ### 限制上传数量 -通过`max-count`属性可以限制上传文件的数量，上传数量达到限制后，会自动隐藏上传区域 +通过`max-count`属性可以限制上传文件的数量，上传数量达到限制后，会自动隐藏上传区域。 ```html @@ -257,7 +257,7 @@ uploadFilePromise(fileName, chooseResult) { ### FileList -`file-list` 为一个对象数组，数组中的每一个对象包含以下 `key` +`file-list` 为一个对象数组，数组中的每一个对象包含以下 `key`。 | 参数 | 说明 | | --------- | ------------------------------------------------------ |