diff --git a/docs/markdown/action-sheet.md b/docs/markdown/action-sheet.md index 1f5ee9628..a0f02b0d4 100644 --- a/docs/markdown/action-sheet.md +++ b/docs/markdown/action-sheet.md @@ -1,7 +1,9 @@ -# ActionSheet 上拉菜单 +# ActionSheet 动作面板 --- +该组件提供了一种多端统一的 `动作面板` 样式与 `IOS` 对齐 在页面上的层级为 `1010` + ## 使用指南 在 Taro 文件中引入组件 diff --git a/docs/markdown/activity-indicator.md b/docs/markdown/activity-indicator.md index c2abf3870..0f30ceb38 100644 --- a/docs/markdown/activity-indicator.md +++ b/docs/markdown/activity-indicator.md @@ -2,6 +2,8 @@ --- +该组件提供一个加载等待元素,也就是Loading组件 + ## 使用指南 在 Taro 文件中引入组件 diff --git a/docs/markdown/card.md b/docs/markdown/card.md index 46c853d09..ef1a3c938 100644 --- a/docs/markdown/card.md +++ b/docs/markdown/card.md @@ -1,7 +1,9 @@ -# Card 浮动布局 +# Card 卡片 --- +提供常见的卡片样式 + ## 使用指南 在 Taro 文件中引入组件 diff --git a/docs/markdown/float-layout.md b/docs/markdown/float-layout.md index 36b8b2cf8..f0bf0e862 100644 --- a/docs/markdown/float-layout.md +++ b/docs/markdown/float-layout.md @@ -2,6 +2,8 @@ --- +提供 `浮动布局` 的功能,在页面上的层级为 `810` + ## 使用指南 在 Taro 文件中引入组件 diff --git a/docs/markdown/grid.md b/docs/markdown/grid.md index 6735be7f2..0a3d5b149 100644 --- a/docs/markdown/grid.md +++ b/docs/markdown/grid.md @@ -2,6 +2,8 @@ --- +提供在移动端常见的 `宫格` 布局,帮助快速实现宫格效果 + ## 使用指南 在 Taro 文件中引入组件 @@ -9,7 +11,7 @@ :::demo ```js -import { AtGrid } from "taro-ui"; +import { AtGrid } from "taro-ui" ``` ::: @@ -92,7 +94,7 @@ import { AtGrid } from "taro-ui"; | 参数 | 说明 | 类型 | 可选值 | 默认值 | | --------- | ------------------ | ----------------------------------- | ------ | ------- | -| data | 宫格布局数据源 | Array[{'{ icon , value , image }'}] | - | - | +| data | 宫格布局数据源 | [{'{ icon? , value? , image? }'}] | - | - | | mode | 元素的标题 | String | - | - | | columnNum | 每一列有多少个 | Number | - | - | -| onClick | 点击宫格触发的时间 | (item: Object, index: number): void | - | `false` | +| onClick | 点击宫格触发的事件 | (item: object, index: number): void | - | `false` | diff --git a/docs/markdown/list.md b/docs/markdown/list.md index 13df5148c..73626e69a 100644 --- a/docs/markdown/list.md +++ b/docs/markdown/list.md @@ -2,6 +2,8 @@ --- +提供常见的 `List` 组件,帮助使用者快速搭建列表 + ## 使用指南 在 Taro 文件中引入组件 @@ -9,7 +11,7 @@ :::demo ```js -import { AtListItem } from "taro-ui" +import { AtList, AtListItem } from "taro-ui" ``` ::: @@ -19,30 +21,59 @@ import { AtListItem } from "taro-ui" :::demo ```html - + + + + + ``` ::: -## 带箭头的 Item +## 带描述信息 :::demo ```html - + + + + + ``` ::: -## 带附加信息的 Item +## 包含图片 :::demo ```html - + + + + + ``` ::: @@ -52,49 +83,27 @@ import { AtListItem } from "taro-ui" :::demo ```html - -``` - -::: - -## 带缩略图的 Item - -:::demo - -```html - -``` - -::: - -## 带描述信息的 Item - -:::demo - -```html - + + + ``` ::: -## AtList 参数 - -| 参数 | 说明 | 类型 | 可选值 | 默认值 | -| ---------- | ---------------------- | -------- | ---------------------- | ------- | -| title | 元素的标题 | String | - | - | -| note | 元素的描述信息 | String | - | - | -| thumb | 元素的主要缩略图 | String | - | - | -| arrow | 箭头的方向 | String | `right`,`top`,`bottom` | - | -| extraText | 额外信息的文本 | String | - | - | -| extraThumb | 额外信息的缩略图 | String | - | - | -| isSwitch | 额外信息是否开关 | Boolean | - | `false` | -| onClick | 用户点击元素触发的事件 | Function | - | - | +## AtListItem 参数 + +| 参数 | 说明 | 类型 | 可选值 | 默认值 | +| -------------- | -------------------------- | -------- | ---------------------- | ------- | +| title | 元素的标题 | String | - | - | +| note | 元素的描述信息 | String | - | - | +| thumb | 元素的主要缩略图 | String | - | - | +| arrow | 箭头的方向 | String | `right`,`top`,`bottom` | - | +| extraText | 额外信息的文本 | String | - | - | +| extraThumb | 额外信息的缩略图 | String | - | - | +| isSwitch | 额外信息是否开关 | Boolean | - | `false` | +| onClick | 用户点击元素触发的事件 | Function | - | - | +| onSwitchChange | 用户点击切换 Switch 时触发 | Function | - | - | diff --git a/docs/markdown/modal.md b/docs/markdown/modal.md index 4b9f5731d..8840bf6cc 100644 --- a/docs/markdown/modal.md +++ b/docs/markdown/modal.md @@ -2,6 +2,8 @@ --- +提供一个简单的 `Modal` 框, 也可以作为 `Dialog (对话框)` 之类的组件使用 在页面上的层级为 `1000` + ## 使用指南 在 Taro 文件中引入组件 diff --git a/docs/markdown/progress.md b/docs/markdown/progress.md index b46ec72d0..84b37c8e2 100644 --- a/docs/markdown/progress.md +++ b/docs/markdown/progress.md @@ -2,6 +2,8 @@ --- +提供一个方便的 `进度条` 组件 + ## 使用指南 在 Taro 文件中引入组件 diff --git a/docs/markdown/toast.md b/docs/markdown/toast.md index 7112662a3..a6feccbee 100644 --- a/docs/markdown/toast.md +++ b/docs/markdown/toast.md @@ -2,6 +2,8 @@ --- +提供一个简单的 `Toast`, 可以传入 `icon` `image` 来展示不同的效果, 另外提供日常使用频繁的三种状态来快速实现效果 页面层级为`1090` + ## 使用指南 在 Taro 文件中引入组件