From 2501ac3a0e5e4427ecd50a41dbfd4cfacb80ed48 Mon Sep 17 00:00:00 2001 From: PanStar Date: Thu, 16 Jan 2020 16:40:54 +0800 Subject: [PATCH] docs: carousel add dotsClass and other doc update (#1732) --- components/carousel/index.en-US.md | 1 + components/carousel/index.zh-CN.md | 19 ++++++++++--------- components/table/index.en-US.md | 2 +- components/table/index.zh-CN.md | 2 +- 4 files changed, 13 insertions(+), 11 deletions(-) diff --git a/components/carousel/index.en-US.md b/components/carousel/index.en-US.md index 423a8a0c3..2495904f2 100644 --- a/components/carousel/index.en-US.md +++ b/components/carousel/index.en-US.md @@ -6,6 +6,7 @@ | autoplay | Whether to scroll automatically | boolean | `false` | | beforeChange | Callback function called before the current index changes | function(from, to) | - | | dots | Whether to show the dots at the bottom of the gallery | boolean | `true` | +| dotsClass | Class name of the dots | string | `slick-dots` | | easing | Transition interpolation function name | string | `linear` | | effect | Transition effect | `scrollx` \| `fade` | `scrollx` | | vertical | Whether to use a vertical display | boolean | `false` | diff --git a/components/carousel/index.zh-CN.md b/components/carousel/index.zh-CN.md index 47e6d5575..af34cb73b 100644 --- a/components/carousel/index.zh-CN.md +++ b/components/carousel/index.zh-CN.md @@ -1,14 +1,15 @@ ## API -| 参数 | 说明 | 类型 | 默认值 | -| ------------ | -------------------------------- | ------------------ | ------- | -| afterChange | 切换面板的回调 | function(current) | 无 | -| autoplay | 是否自动切换 | boolean | false | -| beforeChange | 切换面板的回调 | function(from, to) | 无 | -| dots | 是否显示面板指示点 | boolean | true | -| easing | 动画效果 | string | linear | -| effect | 动画效果函数，可取 scrollx, fade | string | scrollx | -| vertical | 垂直显示 | boolean | false | +| 参数 | 说明 | 类型 | 默认值 | +| ------------ | -------------------------------- | ------------------ | ------------ | +| afterChange | 切换面板的回调 | function(current) | 无 | +| autoplay | 是否自动切换 | boolean | false | +| beforeChange | 切换面板的回调 | function(from, to) | 无 | +| dots | 是否显示面板指示点 | boolean | true | +| dotsClass | 面板指示点类名 | string | `slick-dots` | +| easing | 动画效果 | string | linear | +| effect | 动画效果函数，可取 scrollx, fade | string | scrollx | +| vertical | 垂直显示 | boolean | false | ## 方法 diff --git a/components/table/index.en-US.md b/components/table/index.en-US.md index d35d31800..20555a302 100644 --- a/components/table/index.en-US.md +++ b/components/table/index.en-US.md @@ -6,7 +6,7 @@ | --- | --- | --- | --- | | bordered | Whether to show all table borders | boolean | `false` | | childrenColumnName | The column contains children to display | string\[] | children | -| columns | Columns of table | array | - | +| columns | Columns of table [config](#Column) | array | - | | components | Override default table elements | object | - | | dataSource | Data record array to be displayed | any\[] | - | | defaultExpandAllRows | Expand all rows initially | boolean | `false` | diff --git a/components/table/index.zh-CN.md b/components/table/index.zh-CN.md index c5c03a149..522900b21 100644 --- a/components/table/index.zh-CN.md +++ b/components/table/index.zh-CN.md @@ -6,7 +6,7 @@ | --- | --- | --- | --- | | bordered | 是否展示外边框和列边框 | boolean | false | | childrenColumnName | 指定树形结构的列名 | string\[] | children | -| columns | 表格列的配置描述，具体项见下表 | array | - | +| columns | 表格列的配置描述，具体项见[下表](#Column) | array | - | | components | 覆盖默认的 table 元素 | object | - | | dataSource | 数据数组 | any\[] | | | defaultExpandAllRows | 初始时，是否展开所有行 | boolean | false |