diff --git a/src/action-sheet/README.md b/src/action-sheet/README.md index 32d6cc0e8..6531e66cd 100644 --- a/src/action-sheet/README.md +++ b/src/action-sheet/README.md @@ -93,7 +93,7 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| -| actions | Options | `Array` | `[]` | +| actions | Options | `Action[]` | `[]` | | title | Title | `string` | - | | cancel-text | Text of cancel button | `string` | - | | overlay | Whether to show overlay | `boolean` | `true` | @@ -117,7 +117,7 @@ export default { | close | Triggered when close ActionSheet | - | | closed | Triggered when closed ActionSheet | - | -### Data struct of actions +### Data struct of Action | key | Description | |------|------| diff --git a/src/action-sheet/README.zh-CN.md b/src/action-sheet/README.zh-CN.md index 88e15bce0..23711f655 100644 --- a/src/action-sheet/README.zh-CN.md +++ b/src/action-sheet/README.zh-CN.md @@ -100,7 +100,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| -| actions | 菜单选项 | `Array` | `[]` | - | +| actions | 菜单选项 | `Action[]` | `[]` | - | | title | 标题 | `string` | - | - | | cancel-text | 取消按钮文字 | `string` | - | - | | overlay | 是否显示遮罩层 | `boolean` | `true` | - | @@ -124,7 +124,7 @@ export default { | close | 关闭菜单时触发 | - | | closed | 关闭菜单且动画结束后触发 | - | -### actions +### Action 数据结构 `Props`中的`actions`为一个对象数组，数组中的每一个对象配置每一列，每一列有以下`key`： diff --git a/src/address-edit/README.md b/src/address-edit/README.md index 3569a3220..e08164baf 100644 --- a/src/address-edit/README.md +++ b/src/address-edit/README.md @@ -63,8 +63,8 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| | area-list | Area List | `object` | - | -| address-info | Address Info | `object` | `{}` | -| search-result | Address search result | `Array` | `[]` | +| address-info | Address Info | `AddressInfo` | `{}` | +| search-result | Address search result | `SearchResult[]` | `[]` | | show-postal | Whether to show postal field | `boolean` | `false` | | show-delete | Whether to show delete button | `boolean` | `false` | | show-set-default | Whether to show default address switch | `boolean` | `false` | @@ -105,7 +105,7 @@ Use ref to get address-edit instance and call instance methods |------|------|------|------| | setAddressDetail | addressDetail: string | - | Set address detail | -### addressInfo Data Structure +### AddressInfo Data Structure | key | Description | Type | |------|------|------| @@ -120,7 +120,7 @@ Use ref to get address-edit instance and call instance methods | postalCode | Postal code | `string` | | isDefault | Is default address | `boolean` | -### searchResult Data Structure +### SearchResult Data Structure | key | Description | Type | |------|------|------| diff --git a/src/address-edit/README.zh-CN.md b/src/address-edit/README.zh-CN.md index ac4a33470..19aa41e4d 100644 --- a/src/address-edit/README.zh-CN.md +++ b/src/address-edit/README.zh-CN.md @@ -62,8 +62,8 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| | area-list | 地区列表 | `object` | - | - | -| address-info | 收货人信息初始值 | `object` | `{}` | - | -| search-result | 详细地址搜索结果 | `Array` | `[]` | - | +| address-info | 收货人信息初始值 | `AddressInfo` | `{}` | - | +| search-result | 详细地址搜索结果 | `SearchResult[]` | `[]` | - | | show-postal | 是否显示邮政编码 | `boolean` | `false` | - | | show-delete | 是否显示删除按钮 | `boolean` | `false` | - | | show-set-default | 是否显示默认地址栏 | `boolean` | `false` | - | @@ -104,9 +104,9 @@ export default { |------|------|------|------| | setAddressDetail | addressDetail: string | - | 设置详细地址 | -### addressInfo 数据格式 +### AddressInfo 数据格式 -注意：addressInfo 仅作为初始值传入，表单最终内容可以在 save 事件中获取 +注意：AddressInfo 仅作为初始值传入，表单最终内容可以在 save 事件中获取 | key | 说明 | 类型 | |------|------|------| @@ -121,7 +121,7 @@ export default { | postalCode | 邮政编码 | `string` | | isDefault | 是否为默认地址 | `boolean` | -### searchResult 数据格式 +### SearchResult 数据格式 | key | 说明 | 类型 | |------|------|------| diff --git a/src/address-list/README.md b/src/address-list/README.md index 8dda906a7..97e88c6fb 100644 --- a/src/address-list/README.md +++ b/src/address-list/README.md @@ -69,12 +69,12 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| -| v-model | Id of chosen address | string | - | -| list | Address list | Array | `[]` | -| disabled-list | Disabled address list | `Array` | `[]` | +| v-model | Id of chosen address | `string` | - | +| list | Address list | `Address[]` | `[]` | +| disabled-list | Disabled address list | `Address[]` | `[]` | | disabled-text | Disabled text | `string` | - | | switchable | Whether to allow switch address | `boolean` | `true` | -| add-button-text | Add button text | string | `Add new address` | +| add-button-text | Add button text | `string` | `Add new address` | ### Events diff --git a/src/address-list/README.zh-CN.md b/src/address-list/README.zh-CN.md index deaa8cbc9..906269bda 100644 --- a/src/address-list/README.zh-CN.md +++ b/src/address-list/README.zh-CN.md @@ -71,11 +71,11 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| | v-model | 当前选中地址的 id | `string` | - | - | -| list | 地址列表 | `Array` | `[]` | - | -| add-button-text | 底部按钮文字 | `string` | `新增地址` | - | -| disabled-list | 不可配送地址列表 | `Array` | `[]` | - | +| list | 地址列表 | `Address[]` | `[]` | - | +| disabled-list | 不可配送地址列表 | `Address[]` | `[]` | - | | disabled-text | 不可配送提示文案 | `string` | - | - | | switchable | 是否允许切换地址 | `boolean` | `true` | - | +| add-button-text | 底部按钮文字 | `string` | `新增地址` | - | ### Events @@ -87,7 +87,7 @@ export default { | edit-disabled | 编辑不可配送的地址时触发 | item: 地址对象，index: 索引 | | select-disabled | 选中不可配送的地址时触发 | item: 地址对象，index: 索引 | -### 地址列表字段说明 +### Address 数据结构 | key | 说明 | 类型 | |------|------|------| diff --git a/src/checkbox/README.md b/src/checkbox/README.md index 488d105b5..23a00a2ba 100644 --- a/src/checkbox/README.md +++ b/src/checkbox/README.md @@ -156,7 +156,7 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| -| v-model | Names of all checked checkboxes | `Array` | - | +| v-model | Names of all checked checkboxes | `any[]` | - | | disabled | Disable all checkboxes | `boolean` | `false` | | max | Maximum amount of checked options | `number` | `0`(Unlimited) | diff --git a/src/checkbox/README.zh-CN.md b/src/checkbox/README.zh-CN.md index b64f9dfdb..f9b483736 100644 --- a/src/checkbox/README.zh-CN.md +++ b/src/checkbox/README.zh-CN.md @@ -160,7 +160,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| -| v-model | 所有选中项的标识符 | `Array` | - | - | +| v-model | 所有选中项的标识符 | `any[]` | - | - | | disabled | 是否禁用所有复选框 | `boolean` | `false` | - | | max | 设置最大可选数，0 为无限制 | `number` | `0` | - | diff --git a/src/collapse/README.md b/src/collapse/README.md index 10bffe509..8d911179c 100644 --- a/src/collapse/README.md +++ b/src/collapse/README.md @@ -77,7 +77,7 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| -| v-model | names of current active panels | `Array | string | number` | - | +| v-model | Names of current active panels | `string[] | number[] | string | number` | - | | accordion | Whether to be accordion mode | `boolean` | `false` | | border | Whether to show outer border | `boolean` | `true` | diff --git a/src/collapse/README.zh-CN.md b/src/collapse/README.zh-CN.md index b11978085..ce3b5ee73 100644 --- a/src/collapse/README.zh-CN.md +++ b/src/collapse/README.zh-CN.md @@ -78,7 +78,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| -| v-model | 当前展开面板的 name | `Array | string | number` | - | - | +| v-model | 当前展开面板的 name | `string[] | number[] | string | number` | - | - | | accordion | 是否开启手风琴模式 | `boolean` | `false` | - | | border | 是否显示外边框 | `boolean` | `true` | 1.6.9 | diff --git a/src/contact-card/README.md b/src/contact-card/README.md index fddc3ff60..b69fb1728 100644 --- a/src/contact-card/README.md +++ b/src/contact-card/README.md @@ -152,7 +152,7 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------|------| | v-model | Id of chosen contact | `string | number` | - | -| list | Contact list | `Array` | `[]` | +| list | Contact list | `Contact[]` | `[]` | | add-text | Add button text | `string` | `Add new contact` | ### ContactList Events diff --git a/src/contact-card/README.zh-CN.md b/src/contact-card/README.zh-CN.md index 6c63bbe24..80bd4f912 100644 --- a/src/contact-card/README.zh-CN.md +++ b/src/contact-card/README.zh-CN.md @@ -156,7 +156,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| | v-model | 当前选中联系人的 id | `string | number` | - | - | -| list | 联系人列表 | `Array` | `[]` | - | +| list | 联系人列表 | `Contact[]` | `[]` | - | | add-text | 新建按钮文案 | `string` | `新建联系人` | - | ### ContactList Events @@ -184,7 +184,7 @@ export default { | save | 点击保存按钮时触发 | content：表单内容 | | delete | 点击删除按钮时触发 | content：表单内容 | -### 联系人数据格式 +### Contact 数据结构 | key | 说明 | 类型 | |------|------|------| diff --git a/src/coupon-list/README.md b/src/coupon-list/README.md index 324aa1425..e1207a85d 100644 --- a/src/coupon-list/README.md +++ b/src/coupon-list/README.md @@ -74,7 +74,7 @@ export default { |------|------|------|------| | title | Cell title | `string` | `Coupon` | | chosen-coupon | Index of chosen coupon | `number` | `-1` | -| coupons | Coupon list | `Array` | `[]` | +| coupons | Coupon list | `Coupon[]` | `[]` | | editable | Cell editable | `boolean` | `true` | | border | Whether to show innner border | `boolean` | `true` | | currency | Currency symbol | `string` | `¥` | @@ -85,8 +85,8 @@ export default { |------|------|------|------| | v-model | Current exchange code | `string` | - | | chosen-coupon | Index of chosen coupon | `number` | `-1` | -| coupons | Coupon list | `Array` | `[]` | -| disabled-coupons | Disabled coupon list | `Array` | `[]` | +| coupons | Coupon list | `Coupon[]` | `[]` | +| disabled-coupons | Disabled coupon list | `Coupon[]` | `[]` | | enabled-title | Title of coupon list | `string` | `Available` | - | | disabled-title | Title of disabled coupon list | `string` | `Unavailable` | - | | exchange-button-text | Exchange button text | `string` | `Exchange` | @@ -105,7 +105,7 @@ export default { | change | Triggered when change chosen coupon | index: index of chosen coupon | | exchange | Triggered when exchange coupon | code: exchange code | -### Coupon Item Data Structure +### Coupon Data Structure | key | Description | Type | |------|------|------| diff --git a/src/coupon-list/README.zh-CN.md b/src/coupon-list/README.zh-CN.md index 503dff94c..bf0018948 100644 --- a/src/coupon-list/README.zh-CN.md +++ b/src/coupon-list/README.zh-CN.md @@ -74,7 +74,7 @@ export default { |------|------|------|------|------| | title | 单元格标题 | `string` | `优惠券` | - | | chosen-coupon | 当前选中优惠券的索引 | `number` | `-1` | - | -| coupons | 可用优惠券列表 | `Array` | `[]` | - | +| coupons | 可用优惠券列表 | `Coupon[]` | `[]` | - | | editable | 能否切换优惠券 | `boolean` | `true` | - | | border | 是否显示内边框 | `boolean` | `true` | - | | currency | 货币符号 | `string` | `¥` | - | 1.5.0 | @@ -85,8 +85,8 @@ export default { |------|------|------|------|------| | v-model | 当前输入的兑换码 | `string` | - | - | | chosen-coupon | 当前选中优惠券的索引 | `number` | `-1` | - | -| coupons | 可用优惠券列表 | `Array` | `[]` | - | -| disabled-coupons | 不可用优惠券列表 | `Array` | `[]` | - | +| coupons | 可用优惠券列表 | `Coupon[]` | `[]` | - | +| disabled-coupons | 不可用优惠券列表 | `Coupon[]` | `[]` | - | | enabled-title | 可用优惠券列表标题 | `string` | `可使用优惠券` | - | | disabled-title | 不可用优惠券列表标题 | `string` | `不可使用优惠券` | - | | exchange-button-text | 兑换按钮文字 | `string` | `兑换` | - | @@ -107,7 +107,7 @@ export default { | change | 优惠券切换回调 | index, 选中优惠券的索引 | | exchange | 兑换优惠券回调 | code, 兑换码 | -### 优惠券字段说明 +### Coupon 数据结构 | key | 说明 | 类型 | |------|------|------| diff --git a/src/dialog/README.md b/src/dialog/README.md index bc78d1bff..f92ac7bc2 100644 --- a/src/dialog/README.md +++ b/src/dialog/README.md @@ -120,7 +120,7 @@ export default { | title | Title | `string` | - | | message | Message | `string` | - | | messageAlign | Message text align，can be set to `left` `right` | `string` | `center` | -| className | Custom className | `string | Array | object` | - | +| className | Custom className | `any` | - | | showConfirmButton | Whether to show confirm button | `boolean` | `true` | | showCancelButton | Whether to show cancel button | `boolean` | `false` | | cancelButtonText | Cancel button text | `string` | `Cancel` | diff --git a/src/dialog/README.zh-CN.md b/src/dialog/README.zh-CN.md index abe531ac4..127894a91 100644 --- a/src/dialog/README.zh-CN.md +++ b/src/dialog/README.zh-CN.md @@ -149,7 +149,7 @@ export default { | title | 标题 | `string` | - | - | | message | 文本内容，支持通过`\n`换行 | `string` | - | - | | messageAlign | 内容对齐方式，可选值为`left` `right` | `string` | `center` | 1.5.0 | -| className | 自定义类名 | `string | Array | object` | - | - | +| className | 自定义类名 | `any` | - | - | | showConfirmButton | 是否展示确认按钮 | `boolean` | `true` | - | | showCancelButton | 是否展示取消按钮 | `boolean` | `false` | - | | cancelButtonText | 取消按钮文案 | `string` | `取消` | - | diff --git a/src/dropdown-menu/README.md b/src/dropdown-menu/README.md index fe92ae7c3..0c0b137c6 100644 --- a/src/dropdown-menu/README.md +++ b/src/dropdown-menu/README.md @@ -114,7 +114,7 @@ export default { |------|------|------|------|------| | value | Value of current option，can use `v-model` | `string | number` | - | | title | Item title | `string` | Text of selected option | -| options | Options | `Array` | `[]` | +| options | Options | `Option[]` | `[]` | | disabled | Whether to disable dropdown item | `boolean` | `false` | | title-class | Title class | `string` | - | diff --git a/src/dropdown-menu/README.zh-CN.md b/src/dropdown-menu/README.zh-CN.md index cc786baaf..7dca6fbb0 100644 --- a/src/dropdown-menu/README.zh-CN.md +++ b/src/dropdown-menu/README.zh-CN.md @@ -118,7 +118,7 @@ export default { |------|------|------|------|------| | value | 当前选中项对应的 value，可以通过`v-model`双向绑定 | `string | number` | - | - | | title | 菜单项标题 | `string` | 当前选中项文字 | - | -| options | 选项数组 | `Array` | `[]` | - | +| options | 选项数组 | `Option[]` | `[]` | - | | disabled | 是否禁用菜单 | `boolean` | `false` | - | | title-class | 标题额外类名 | `string` | - | - | diff --git a/src/image-preview/README.md b/src/image-preview/README.md index ca7e49b7a..c5f81fa14 100644 --- a/src/image-preview/README.md +++ b/src/image-preview/README.md @@ -89,7 +89,7 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| -| images | Images URL list | `Array` | `[]` | +| images | Images URL list | `string[]` | `[]` | | startPosition | Start position | `number` | `0` | | showIndex | Whether to show index | `boolean` | `true` | | showIndicators | Whether to show indicators | `boolean` | `false` | @@ -98,7 +98,7 @@ export default { | onChange | Triggered when current image change | `Function` | - | | closeOnPopstate | Whether to close when popstate | `boolean` | `false` | | asyncClose | Whether to enable async close | `boolean` | `false` | -| className | Custom className | `string | Array | object` | - | +| className | Custom className | `any` | - | | lazyLoad | Whether to enable thumb lazy load，should register [Lazyload](#/en-US/lazyload) component | `boolean` | `false` | | maxZoom | Max zoom | `number` | `3` | | minZoom | Min zoom | `number` | `1/3` | @@ -107,14 +107,14 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| -| images | Images URL list | `Array` | `[]` | +| images | Images URL list | `string[]` | `[]` | | start-position | Start position | `number` | `0` | | show-index | Whether to show index | `boolean` | `true` | | show-indicators | Whether to show indicators | `boolean` | `false` | | loop | Whether to enable loop | `boolean` | `true` | | async-close | Whether to enable async close | `boolean` | `false` | | close-on-popstate | Whether to close when popstate | `boolean` | `false` | -| class-name | Custom className | `string | Array | object` | - | +| class-name | Custom className | `any` | - | | lazy-load | Whether to enable thumb lazy load，should register [Lazyload](#/en-US/lazyload) component | `boolean` | `false` | | max-zoom | Max zoom | `number` | `3` | | min-zoom | Min zoom | `number` | `1/3` | diff --git a/src/image-preview/README.zh-CN.md b/src/image-preview/README.zh-CN.md index 8198d785e..0559c9202 100644 --- a/src/image-preview/README.zh-CN.md +++ b/src/image-preview/README.zh-CN.md @@ -101,7 +101,7 @@ export default { | 参数名 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| -| images | 需要预览的图片 URL 数组 | `Array` | `[]` | - | +| images | 需要预览的图片 URL 数组 | `string[]` | `[]` | - | | startPosition | 图片预览起始位置索引 | `number` | `0` | - | | showIndex | 是否显示页码 | `boolean` | `true` | - | | showIndicators | 是否显示轮播指示器 | `boolean` | `false` | - | @@ -110,7 +110,7 @@ export default { | onChange | 切换图片时的回调函数，回调参数为当前索引 | `Function` | - | 2.0.3 | | asyncClose | 是否开启异步关闭 | `boolean` | `false` | - | | closeOnPopstate | 是否在页面回退时自动关闭 | `boolean` | `false` | 2.0.0 | -| className | 自定义类名 | `string | Array | object` | - | 1.5.2 | +| className | 自定义类名 | `any` | - | 1.5.2 | | lazyLoad | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | `boolean` | `false` | 1.5.3 | | maxZoom | 手势缩放时，最大缩放比例 | `number` | `3` | 1.6.14 | | minZoom | 手势缩放时，最小缩放比例 | `number` | `1/3` | 1.6.14 | @@ -121,14 +121,14 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| -| images | 需要预览的图片 URL 数组 | `Array` | `[]` | 1.1.16 | +| images | 需要预览的图片 URL 数组 | `string[]` | `[]` | 1.1.16 | | start-position | 图片预览起始位置索引 | `number` | `0` | 1.1.16 | | show-index | 是否显示页码 | `boolean` | `true` | 1.3.4 | | show-indicators | 是否显示轮播指示器 | `boolean` | `false` | 1.3.10 | | loop | 是否开启循环播放 | `boolean` | `true` | 1.4.4 | | async-close | 是否开启异步关闭 | `boolean` | `false` | 1.4.8 | | close-on-popstate | 是否在页面回退时自动关闭 | `boolean` | `false` | -| class-name | 自定义类名 | `string | Array | object` | - | 1.5.2 | +| class-name | 自定义类名 | `any` | - | 1.5.2 | | lazy-load | 是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用 | `boolean` | `false` | 1.5.3 | | max-zoom | 手势缩放时，最大缩放比例 | `number` | `3` | 1.6.14 | | min-zoom | 手势缩放时，最小缩放比例 | `number` | `1/3` | 1.6.14 | diff --git a/src/index-bar/README.md b/src/index-bar/README.md index 32351ce9e..f3e3f761d 100644 --- a/src/index-bar/README.md +++ b/src/index-bar/README.md @@ -62,7 +62,7 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| -| index-list | Index List | `Array` | `A-Z` | +| index-list | Index List | `string[] | number[]` | `A-Z` | | z-index | z-index | `number` | `1` | | sticky | Whether to enable anchor sticky top | `boolean` | `true` | | sticky-offset-top | Anchor offset top when sticky | `number` | `0` | diff --git a/src/index-bar/README.zh-CN.md b/src/index-bar/README.zh-CN.md index d130b0a07..f454ca74c 100644 --- a/src/index-bar/README.zh-CN.md +++ b/src/index-bar/README.zh-CN.md @@ -66,7 +66,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| -| index-list | 索引字符列表 | `Array` | `A-Z` | - | +| index-list | 索引字符列表 | `string[] | number[]` | `A-Z` | - | | z-index | z-index 层级 | `number` | `1` | - | | sticky | 是否开启锚点自动吸顶 | `boolean` | `true` | - | | sticky-offset-top | 锚点自动吸顶时与顶部的距离 | `number` | `0` | 2.0.7 | diff --git a/src/lazyload/README.md b/src/lazyload/README.md index f1e97fb9f..5bc473af2 100644 --- a/src/lazyload/README.md +++ b/src/lazyload/README.md @@ -56,7 +56,7 @@ Use `v-lazy:background-image` to set background url, and declare the height of t | error | Src of the image upon load fail | `string` | - | | preload | Proportion of pre-loading height | `string` | - | | attempt | Attempts count | `number` | `3` | -| listenEvents | Events that you want vue listen for | `Array` | `scroll`... | +| listenEvents | Events that you want vue listen for | `string[]` | `scroll`... | | adapter | Dynamically modify the attribute of element | `object` | - | | filter | The image's listener filter | `object` | - | | lazyComponent | Lazyload component | `boolean` | `false` | diff --git a/src/lazyload/README.zh-CN.md b/src/lazyload/README.zh-CN.md index 89815d206..c50c489a9 100644 --- a/src/lazyload/README.zh-CN.md +++ b/src/lazyload/README.zh-CN.md @@ -63,7 +63,7 @@ export default { | error | 错误时的图片 | `string` | - | - | | preload | 预加载高度的比例 | `string` | - | - | | attempt | 尝试次数 | `number` | `3` | - | -| listenEvents | 监听的事件 | `Array` | `scroll`等 | - | +| listenEvents | 监听的事件 | `string[]` | `scroll`等 | - | | adapter | 适配器 | `object` | - | - | | filter | 图片 URL 过滤 | `object` | - | - | | lazyComponent | 是否能懒加载模块 | `boolean` | `false` | - | diff --git a/src/notify/README.md b/src/notify/README.md index 42157ac11..c008531fc 100644 --- a/src/notify/README.md +++ b/src/notify/README.md @@ -57,7 +57,7 @@ export default { | duration | Duration(ms), won't disappear if value is 0 | `number` | `3000` | | color | Message color | `string` | `#fff` | | | background | Background color | `string` | `#f44` | -| className | Custom className | `string | Array | object` | - | +| className | Custom className | `any` | - | | onClick | Callback function after click | `Function` | - | | onOpened | Callback function after opened | `Function` | - | | onClose | Callback function after close | `Function` | - | diff --git a/src/notify/README.zh-CN.md b/src/notify/README.zh-CN.md index a64d49b5f..1e977c151 100644 --- a/src/notify/README.zh-CN.md +++ b/src/notify/README.zh-CN.md @@ -57,7 +57,7 @@ export default { | duration | 展示时长(ms)，值为 0 时，notify 不会消失 | `number` | `3000` | - | | color | 字体颜色 | `string` | `#fff` | - | | background | 背景颜色 | `string` | `#f44` | - | -| className | 自定义类名 | `string | Array | object` | - | 1.6.0 | +| className | 自定义类名 | `any` | - | 1.6.0 | | onClick | 点击时的回调函数 | `Function` | - | 2.0.0 | | onOpened | 完全展示后的回调函数 | `Function` | - | 2.0.0 | | onClose | 关闭时的回调函数 | `Function` | - | 2.0.0 | diff --git a/src/picker/README.md b/src/picker/README.md index f3469fedb..221a8d4ae 100644 --- a/src/picker/README.md +++ b/src/picker/README.md @@ -185,7 +185,7 @@ When Picker columns data is acquired asynchronously, use `loading` prop to show | Attribute | Description | Type | Default | |------|------|------|------| -| columns | Columns data | `Array` | `[]` | +| columns | Columns data | `Column[]` | `[]` | | show-toolbar | Whether to show toolbar | `boolean` | `false` | | toolbar-position | Toolbar position, cat be set to `bottom` | `string` | `top` | | title | Toolbar title | `string` | `''` | @@ -198,6 +198,7 @@ When Picker columns data is acquired asynchronously, use `loading` prop to show | default-index | Default value index of single column picker | `number` | `0` | ### Events + Picker events will pass different parameters according to the columns are single or multiple | Event | Description | Arguments | @@ -212,7 +213,7 @@ Picker events will pass different parameters according to the columns are single |------|------| | title | Custom title | -### Data struct of columns +### Column Data Struct | key | Description | |------|------| diff --git a/src/picker/README.zh-CN.md b/src/picker/README.zh-CN.md index 86beb32d6..0f023cd4a 100644 --- a/src/picker/README.zh-CN.md +++ b/src/picker/README.zh-CN.md @@ -193,7 +193,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| -| columns | 对象数组，配置每一列显示的数据 | `Array` | `[]` | - | +| columns | 对象数组，配置每一列显示的数据 | `Column[]` | `[]` | - | | show-toolbar | 是否显示顶部栏 | `boolean` | `false` | - | | toolbar-position | 顶部栏位置，可选值为`bottom` | `string` | `top` | 2.0.0 | | title | 顶部栏标题 | `string` | `''` | - | @@ -221,7 +221,7 @@ Picker 组件的事件会根据 columns 是单列或多列返回不同的参数 |------|------| | title | 自定义标题内容 | -### Columns 数据结构 +### Column 数据结构 当传入多列数据时，`columns`为一个对象数组，数组中的每一个对象配置每一列，每一列有以下`key` diff --git a/src/skeleton/README.md b/src/skeleton/README.md index 5c2c49bfd..c07299890 100644 --- a/src/skeleton/README.md +++ b/src/skeleton/README.md @@ -55,7 +55,7 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| | row | Row count | `number` | `0` | -| row-width | Row width, can be array | `number | string | Array` | `100%` | +| row-width | Row width, can be array | `number | string | number[] | string []` | `100%` | | title | Whether to show title placeholder | `boolean` | `false` | | title-width | Title width | `number | string` | `40%` | | avatar | Whether to show avatar placeholder | `boolean` | `false` | diff --git a/src/skeleton/README.zh-CN.md b/src/skeleton/README.zh-CN.md index 6c40edf0c..b624dca22 100644 --- a/src/skeleton/README.zh-CN.md +++ b/src/skeleton/README.zh-CN.md @@ -61,7 +61,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| | row | 段落占位图行数 | `number` | `0` | - | -| row-width | 段落占位图宽度，可传数组来设置每一行的宽度 | `number | string | Array` | `100%` | - | +| row-width | 段落占位图宽度，可传数组来设置每一行的宽度 | `number | string | number[] | string[]` | `100%` | - | | title | 是否显示标题占位图 | `boolean` | `false` | - | | title-width | 标题占位图宽度 | `number | string` | `40%` | - | | avatar | 是否显示头像占位图 | `boolean` | `false` | - | diff --git a/src/toast/README.md b/src/toast/README.md index 5f4cd1910..d0e299f92 100644 --- a/src/toast/README.md +++ b/src/toast/README.md @@ -121,7 +121,7 @@ toast2.clear(); | forbidClick | Whether to forbid click background | `boolean` | `false` | | loadingType | Loading icon type, can be set to `spinner` | `string` | `circular` | | duration | Toast duration(ms), won't disappear if value is 0 | `number` | `3000` | -| className | Custom className | `string | Array | object` | - | +| className | Custom className | `any` | - | | onOpened | Callback function after opened | `Function` | - | | onClose | Callback function after close | `Function` | - | | getContainer | Return the mount node for Toast | `string | () => HTMLElement` | `body` | diff --git a/src/toast/README.zh-CN.md b/src/toast/README.zh-CN.md index 6b67cf0ca..4e5c56cc8 100644 --- a/src/toast/README.zh-CN.md +++ b/src/toast/README.zh-CN.md @@ -121,7 +121,7 @@ toast2.clear(); | forbidClick | 是否禁止背景点击 | `boolean` | `false` | - | | loadingType | 加载图标类型, 可选值为 `spinner` | `string` | `circular` | - | | duration | 展示时长(ms)，值为 0 时，toast 不会消失 | `number` | `3000` | - | -| className | 自定义类名 | `string | Array | object` | - | 1.6.0 | +| className | 自定义类名 | `any` | - | 1.6.0 | | onOpened | 完全展示后的回调函数 | `Function` | - | 2.0.0 | | onClose | 关闭时的回调函数 | `Function` | - | 1.6.10 | | getContainer | 指定挂载的节点，可以传入选择器，
或一个返回节点的函数 | `string | () => HTMLElement` | `body` | 1.6.3 | diff --git a/src/tree-select/README.md b/src/tree-select/README.md index a2b7768f4..f6a780b03 100644 --- a/src/tree-select/README.md +++ b/src/tree-select/README.md @@ -50,7 +50,7 @@ export default { | Attribute | Description | Type | Default | |------|------|------|------| -| items | Required datasets for the component, see Data Structure for detail. | `Array` | `[]` | +| items | Required datasets for the component | `Item[]` | `[]` | | height | Height (px) | `number` | `300` | | main-Active-index | The index of selected parent node | `number` | `0` | | active-id | Id of selected item | `string | number` | `0` | @@ -62,7 +62,7 @@ export default { | navclick | triggered when parent node is selected | index: index of selected parent | | itemclick | triggered when item is selected | data: selected item | -### Data Structure +### Item Data Structure `items` should be an array contains specified tree objects. diff --git a/src/tree-select/README.zh-CN.md b/src/tree-select/README.zh-CN.md index da85b0661..a2ea3e259 100644 --- a/src/tree-select/README.zh-CN.md +++ b/src/tree-select/README.zh-CN.md @@ -50,7 +50,7 @@ export default { | 参数 | 说明 | 类型 | 默认值 | 版本 | |------|------|------|------|------| -| items | 分类显示所需的数据，结构参见下方 | `Array` | `[]` | - | +| items | 分类显示所需的数据 | `Item[]` | `[]` | - | | height | 高度，单位为 px | `number` | `300` | - | | main-active-index | 左侧导航高亮的索引 | `number` | `0` | - | | active-id | 右侧选择项，高亮的数据id | `string | number` | `0` | - | @@ -62,7 +62,7 @@ export default { | navclick | 左侧导航点击时，触发的事件 | index：被点击的导航的索引 | | itemclick | 右侧选择项被点击时，会触发的事件 | data: 该点击项的数据 | -### items 分类显示所需数据的数据结构 +### Item 数据结构 `items` 整体为一个数组，数组内包含一系列描述分类的对象。