diff --git a/packages/action-sheet/README.md b/packages/action-sheet/README.md index 3155c06f..369af168 100644 --- a/packages/action-sheet/README.md +++ b/packages/action-sheet/README.md @@ -1,5 +1,9 @@ # ActionSheet 上拉菜单 +### 介绍 + +底部弹起的模态面板,包含与当前情境相关的多个选项。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/button/README.md b/packages/button/README.md index dca183ec..e3d63062 100644 --- a/packages/button/README.md +++ b/packages/button/README.md @@ -1,5 +1,9 @@ # Button 按钮 +### 介绍 + +按钮用于触发一个操作,如提交表单。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/calendar/README.md b/packages/calendar/README.md index b6290e44..7718742f 100644 --- a/packages/calendar/README.md +++ b/packages/calendar/README.md @@ -1,5 +1,9 @@ # Calendar 日历 +### 介绍 + +日历组件用于选择日期或日期区间。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/card/README.md b/packages/card/README.md index 21a059f3..31caeb0c 100644 --- a/packages/card/README.md +++ b/packages/card/README.md @@ -1,5 +1,9 @@ # Card 商品卡片 +### 介绍 + +商品卡片,用于展示商品的图片、价格等信息。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/cell/README.md b/packages/cell/README.md index 506760e2..f035b1bd 100644 --- a/packages/cell/README.md +++ b/packages/cell/README.md @@ -1,5 +1,9 @@ # Cell 单元格 +### 介绍 + +单元格为列表中的单个展示项。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/checkbox/README.md b/packages/checkbox/README.md index abed4657..6845e152 100644 --- a/packages/checkbox/README.md +++ b/packages/checkbox/README.md @@ -1,5 +1,9 @@ # Checkbox 复选框 +### 介绍 + +在一组备选项中进行多选。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) @@ -185,7 +189,7 @@ Page({ this.setData({ result: event.detail }); - } + }, toggle(event) { const { index } = event.currentTarget.dataset; diff --git a/packages/circle/README.md b/packages/circle/README.md index df3d171d..ce23207a 100644 --- a/packages/circle/README.md +++ b/packages/circle/README.md @@ -1,5 +1,9 @@ # Circle 环形进度条 +### 介绍 + +圆环形的进度条组件,支持进度渐变动画。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/collapse/README.md b/packages/collapse/README.md index a67e54c4..cc6c3cb0 100644 --- a/packages/collapse/README.md +++ b/packages/collapse/README.md @@ -1,5 +1,9 @@ # Collapse 折叠面板 +### 介绍 + +将一组内容放置在多个折叠面板中,点击面板的标题可以展开或收缩其内容。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/count-down/README.md b/packages/count-down/README.md index cf5f138a..483d379a 100644 --- a/packages/count-down/README.md +++ b/packages/count-down/README.md @@ -1,5 +1,9 @@ # CountDown 倒计时 +### 介绍 + +用于实时展示倒计时数值,支持毫秒精度。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/dialog/README.md b/packages/dialog/README.md index 2492c03a..5a4085f3 100644 --- a/packages/dialog/README.md +++ b/packages/dialog/README.md @@ -2,9 +2,7 @@ ### 介绍 -弹出模态框,常用于消息提示、消息确认、在当前页面内完成特定的交互操作 - -弹出框组件支持函数调用和组件调用两种方式 +弹出模态框,常用于消息提示、消息确认,或在当前页面内完成特定的交互操作,支持函数调用和组件调用两种方式。 ### 引入 diff --git a/packages/divider/README.md b/packages/divider/README.md index cf718615..679b8fa6 100644 --- a/packages/divider/README.md +++ b/packages/divider/README.md @@ -1,5 +1,9 @@ # Divider 分割线 +### 介绍 + +用于将内容分隔为多个区域。 + ### 引入 在`app.json`或`index.json`中引入组件,默认为`ES6`版本,`ES5`引入方式参见[快速上手](#/quickstart) diff --git a/packages/dropdown-menu/README.md b/packages/dropdown-menu/README.md index e327a011..4cb87dd4 100644 --- a/packages/dropdown-menu/README.md +++ b/packages/dropdown-menu/README.md @@ -1,5 +1,9 @@ # DropdownMenu 下拉菜单 +### 介绍 + +向下弹出的菜单列表。 + ### 引入 在`app.json`或`index.json`中引入组件,默认为`ES6`版本,`ES5`引入方式参见[快速上手](#/quickstart) diff --git a/packages/goods-action/README.md b/packages/goods-action/README.md index 5c506065..ebb19f34 100644 --- a/packages/goods-action/README.md +++ b/packages/goods-action/README.md @@ -1,5 +1,9 @@ # GoodsAction 商品导航 +### 介绍 + +用于为商品相关操作提供便捷交互。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/icon/README.md b/packages/icon/README.md index 810011ca..baefbd3c 100644 --- a/packages/icon/README.md +++ b/packages/icon/README.md @@ -2,7 +2,7 @@ ### 介绍 -基于字体的图标集, 可以通过 Icon 组件使用,也可以在其他组件中通过`icon`属性引用 +基于字体的图标集,可以通过 Icon 组件使用,也可以在其他组件中通过 icon 属性引用。 ### 引入 diff --git a/packages/index-bar/README.md b/packages/index-bar/README.md index 80854dea..0289e677 100644 --- a/packages/index-bar/README.md +++ b/packages/index-bar/README.md @@ -1,5 +1,9 @@ # IndexBar 索引栏 +### 介绍 + +用于列表的索引分类显示和快速定位。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/loading/README.md b/packages/loading/README.md index f7036bbb..a52ffab7 100644 --- a/packages/loading/README.md +++ b/packages/loading/README.md @@ -1,5 +1,9 @@ # Loading 加载 +### 介绍 + +加载图标,用于表示加载中的过渡状态。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/nav-bar/README.md b/packages/nav-bar/README.md index 28064008..ed8419fc 100644 --- a/packages/nav-bar/README.md +++ b/packages/nav-bar/README.md @@ -1,5 +1,9 @@ # NavBar 导航栏 +### 介绍 + +为页面提供导航功能,常用于页面顶部。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/notice-bar/README.md b/packages/notice-bar/README.md index 74446b3e..6f8868c3 100644 --- a/packages/notice-bar/README.md +++ b/packages/notice-bar/README.md @@ -1,5 +1,9 @@ # NoticeBar 通告栏 +### 介绍 + +用于循环播放展示一组消息通知。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/notify/README.md b/packages/notify/README.md index d4ad26e0..035c44dd 100644 --- a/packages/notify/README.md +++ b/packages/notify/README.md @@ -1,5 +1,9 @@ # Notify 消息提示 +### 介绍 + +在页面顶部展示消息提示,支持函数调用和组件调用两种方式。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/progress/README.md b/packages/progress/README.md index ef357ecb..f6257371 100644 --- a/packages/progress/README.md +++ b/packages/progress/README.md @@ -1,5 +1,9 @@ # Progress 进度条 +### 介绍 + +用于展示操作的当前进度。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/radio/README.md b/packages/radio/README.md index 70ea5017..c9d8dfa0 100644 --- a/packages/radio/README.md +++ b/packages/radio/README.md @@ -1,5 +1,9 @@ # Radio 单选框 +### 介绍 + +在一组备选项中进行单选。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/rate/README.md b/packages/rate/README.md index b0513ed7..c40af59e 100644 --- a/packages/rate/README.md +++ b/packages/rate/README.md @@ -1,5 +1,9 @@ # Rate 评分 +### 介绍 + +用于对事物进行评级操作。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/search/README.md b/packages/search/README.md index 3146de28..a87db042 100644 --- a/packages/search/README.md +++ b/packages/search/README.md @@ -1,5 +1,9 @@ # Search 搜索 +### 介绍 + +用于搜索场景的输入框组件。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/sidebar/README.md b/packages/sidebar/README.md index 3eaf6aea..8dadeb9d 100644 --- a/packages/sidebar/README.md +++ b/packages/sidebar/README.md @@ -1,5 +1,9 @@ # Sidebar 侧边导航 +### 介绍 + +垂直展示的导航栏,用于在不同的内容区域之间进行切换。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/skeleton/README.md b/packages/skeleton/README.md index 18f455b8..3da24c65 100644 --- a/packages/skeleton/README.md +++ b/packages/skeleton/README.md @@ -1,5 +1,9 @@ # Skeleton 骨架屏 +### 介绍 + +用于在内容加载过程中展示一组占位图形。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/slider/README.md b/packages/slider/README.md index 7c5b05e3..eccc9bf9 100644 --- a/packages/slider/README.md +++ b/packages/slider/README.md @@ -1,5 +1,9 @@ # Slider 滑块 +### 介绍 + +滑动输入条,用于在给定的范围内选择一个值。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/steps/README.md b/packages/steps/README.md index b344e82f..257461b6 100644 --- a/packages/steps/README.md +++ b/packages/steps/README.md @@ -1,5 +1,9 @@ # Steps 步骤条 +### 介绍 + +用于展示操作流程的各个环节,让用户了解当前的操作在整体流程中的位置。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/submit-bar/README.md b/packages/submit-bar/README.md index aba9cc3c..8740ef49 100644 --- a/packages/submit-bar/README.md +++ b/packages/submit-bar/README.md @@ -1,5 +1,9 @@ # SubmitBar 提交订单栏 +### 介绍 + +用于展示订单金额与提交订单。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/swipe-cell/README.md b/packages/swipe-cell/README.md index cf71654d..f9c7ba82 100644 --- a/packages/swipe-cell/README.md +++ b/packages/swipe-cell/README.md @@ -1,5 +1,9 @@ # SwipeCell 滑动单元格 +### 介绍 + +可以左右滑动来展示操作按钮的单元格组件。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/switch/README.md b/packages/switch/README.md index ef043a25..cc30bfe9 100644 --- a/packages/switch/README.md +++ b/packages/switch/README.md @@ -1,5 +1,9 @@ # Switch 开关 +### 介绍 + +用于在打开和关闭状态之间进行切换。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/tab/README.md b/packages/tab/README.md index cb3d9522..60d783de 100644 --- a/packages/tab/README.md +++ b/packages/tab/README.md @@ -1,5 +1,9 @@ # Tab 标签页 +### 介绍 + +选项卡组件,用于在不同的内容区域之间进行切换。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/tabbar/README.md b/packages/tabbar/README.md index b0edd12a..03435352 100644 --- a/packages/tabbar/README.md +++ b/packages/tabbar/README.md @@ -1,5 +1,9 @@ # Tabbar 标签栏 +### 介绍 + +底部导航栏,用于在不同页面之间进行切换。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/tag/README.md b/packages/tag/README.md index 8fa916f8..c8500477 100644 --- a/packages/tag/README.md +++ b/packages/tag/README.md @@ -1,5 +1,9 @@ # Tag 标签 +### 介绍 + +用于标记关键词和概括主要内容。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/toast/README.md b/packages/toast/README.md index a26baa82..3d2038db 100644 --- a/packages/toast/README.md +++ b/packages/toast/README.md @@ -1,5 +1,9 @@ # Toast 轻提示 +### 介绍 + +在页面中间弹出黑色半透明提示,用于消息通知、加载提示、操作结果提示等场景。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/transition/README.md b/packages/transition/README.md index 2efe6738..54a6b8b2 100644 --- a/packages/transition/README.md +++ b/packages/transition/README.md @@ -1,5 +1,9 @@ # Transition 动画 +### 介绍 + +使元素从一种样式逐渐变化为另一种样式的效果。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/tree-select/README.md b/packages/tree-select/README.md index 970606e6..39bc6db4 100644 --- a/packages/tree-select/README.md +++ b/packages/tree-select/README.md @@ -1,5 +1,9 @@ # TreeSelect 分类选择 +### 介绍 + +用于从一组相关联的数据集合中进行选择。 + ### 引入 在`app.json`或`index.json`中引入组件,详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian) diff --git a/packages/uploader/README.md b/packages/uploader/README.md index fc002a78..a5a6726f 100644 --- a/packages/uploader/README.md +++ b/packages/uploader/README.md @@ -1,5 +1,9 @@ # Uploader 文件上传 +### 介绍 + +用于将本地的图片或文件上传至服务器,并在上传过程中展示预览图和上传进度。目前 Uploader 组件不包含将文件上传至服务器的接口逻辑,该步骤需要自行实现。 + ### 引入 在`app.json`或`index.json`中引入组件,默认为`ES6`版本,`ES5`引入方式参见[快速上手](#/quickstart) @@ -186,7 +190,7 @@ Page({ ```js // 上传图片 -uploadToCloud() { +uploadToCloud() { wx.cloud.init(); const { fileList } = this.data; if (!fileList.length) {