docs(React): generate api doc for multiple components (#616)

Author: anlyyao

db/TDesign.db

@@ -2,6 +2,8 @@
  * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
  * */
 
-import { TdGridItemProps } from './type';
+import { TdGridProps, TdGridItemProps } from './type';
+
+export const gridDefaultProps: TdGridProps = { align: 'center', border: false, column: 4, theme: 'default' };
 
 export const gridItemDefaultProps: TdGridItemProps = { badge: null, layout: 'vertical' };

packages/products/tdesign-mobile-react/src/grid/defaultProps.ts

@@ -2,7 +2,6 @@
 
 ## API
 
-
 ### Grid Props
 
 name | type | default | description | required
@@ -24,6 +23,6 @@ className | String | - | className of component | N
 style | Object | - | CSS(Cascading Style Sheets)，Typescript：`React.CSSProperties` | N
 badge | Object | null | Typescript：`BadgeProps`，[Badge API Documents](./badge?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/grid/type.ts) | N
 description | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
-image | TNode | - | Typescript：`string \| object \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
+image | TNode | - | Typescript：`String \| TNode  \| ImageProps`，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/grid/type.ts) | N
 layout | String | vertical | options: vertical/horizontal | N
 text | TNode | - | Typescript：`string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N

packages/products/tdesign-mobile-react/src/grid/grid.en-US.md

@@ -2,7 +2,6 @@
 
 ## API
 
-
 ### Grid Props
 
 名称 | 类型 | 默认值 | 描述 | 必传
@@ -24,6 +23,6 @@ className | String | - | 类名 | N
 style | Object | - | 样式，TS 类型：`React.CSSProperties` | N
 badge | Object | null | 透传至 Badge 属性。TS 类型：`BadgeProps`，[Badge API Documents](./badge?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/grid/type.ts) | N
 description | TNode | - | 文本以外的更多描述，辅助信息。可以通过 Props 传入文本，也可以自定义标题节点。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
-image | TNode | - | 图片，可以是图片地址，也可以自定义图片节点，如果传入对象则透传至 image 组件。TS 类型：`string \| object \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
+image | TNode | - | 图片，可以是图片地址，也可以自定义图片节点，如果传入对象则透传至 image 组件。TS 类型：`String \| TNode  \| ImageProps`，[Image API Documents](./image?tab=api)。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/grid/type.ts) | N
 layout | String | vertical | 内容布局方式。可选项：vertical/horizontal | N
 text | TNode | - | 文本，可以通过 Props 传入文本，也可以自定义标题节点。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N

packages/products/tdesign-mobile-react/src/grid/grid.md

@@ -5,8 +5,36 @@
  * */
 
 import { BadgeProps } from '../badge';
+import { ImageProps } from '../image';
 import { TNode } from '../common';
 
+export interface TdGridProps {
+  /**
+   * 内容对齐方式
+   * @default center
+   */
+  align?: 'left' | 'center';
+  /**
+   * 是否显示边框
+   * @default false
+   */
+  border?: boolean;
+  /**
+   * 每一行的列数量；为 0 时等于固定大小
+   * @default 4
+   */
+  column?: number;
+  /**
+   * 间隔大小
+   */
+  gutter?: number;
+  /**
+   * 宫格的风格
+   * @default default
+   */
+  theme?: 'default' | 'card';
+}
+
 export interface TdGridItemProps {
   /**
    * 透传至 Badge 属性
@@ -20,7 +48,7 @@ export interface TdGridItemProps {
   /**
    * 图片，可以是图片地址，也可以自定义图片节点，如果传入对象则透传至 image 组件
    */
-  image?: TNode;
+  image?: String | TNode | ImageProps;
   /**
    * 内容布局方式
    * @default vertical

packages/products/tdesign-mobile-react/src/grid/type.ts

@@ -12,6 +12,6 @@ content | TNode | - | Typescript：`string \| TNode`。[see more ts definition](
 disabled | Boolean | - | \- | N
 left | TNode | - | Typescript：`Array<SwipeActionItem> \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
 opened | Boolean / Array | false | Typescript：`boolean \| Array<boolean>` | N
-right | TNode | - | Typescript：`Array<SwipeActionItem> \| TNode` `interface SwipeActionItem {text: string; className?: string; style?: string; sure?: string \| TNode; onClick?: () => void; [key: string]: any }`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/swipe-cell/type.ts) | N
+right | TNode | - | Typescript：`Array<SwipeActionItem> \| TNode` `interface SwipeActionItem {text: string; className?: string; style?: Styles; sure?: Sure; onClick?: () => void; [key: string]: any }` `type Sure = string \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts)。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/swipe-cell/type.ts) | N
 onChange | Function |  | Typescript：`(value: string) => void`<br/> | N
 onClick | Function |  | Typescript：`(action: SwipeActionItem, source: SwipeSource) => void`<br/>[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/swipe-cell/type.ts)。<br/>`type SwipeSource = 'left' \| 'right'`<br/> | N

packages/products/tdesign-mobile-react/src/swipe-cell/swipe-cell.en-US.md

@@ -12,6 +12,6 @@ content | TNode | - | 操作项以外的内容。TS 类型：`string \| TNode`
 disabled | Boolean | - | 是否禁用滑动 | N
 left | TNode | - | 左侧滑动操作项。所有行为同 `right`。TS 类型：`Array<SwipeActionItem> \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
 opened | Boolean / Array | false | 操作项是否呈现为打开态，值为数组时表示分别控制左右滑动的展开和收起状态。TS 类型：`boolean \| Array<boolean>` | N
-right | TNode | - | 右侧滑动操作项。有两种定义方式，一种是使用数组，二种是使用插槽。`right.text` 表示操作文本，`right.className` 表示操作项类名，`right.style` 表示操作项样式，`right.onClick` 表示点击操作项后执行的回调函数。示例：`[{ text: '删除', style: 'background-color: red', onClick: () => {} }]`。TS 类型：`Array<SwipeActionItem> \| TNode` `interface SwipeActionItem {text: string; className?: string; style?: string; sure?: string \| TNode; onClick?: () => void; [key: string]: any }`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/swipe-cell/type.ts) | N
+right | TNode | - | 右侧滑动操作项。有两种定义方式，一种是使用数组，二种是使用插槽。`right.text` 表示操作文本，`right.className` 表示操作项类名，`right.style` 表示操作项样式，`right.onClick` 表示点击操作项后执行的回调函数。示例：`[{ text: '删除', style: 'background-color: red', onClick: () => {} }]`。TS 类型：`Array<SwipeActionItem> \| TNode` `interface SwipeActionItem {text: string; className?: string; style?: Styles; sure?: Sure; onClick?: () => void; [key: string]: any }` `type Sure = string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts)。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/swipe-cell/type.ts) | N
 onChange | Function |  | TS 类型：`(value: string) => void`<br/>菜单展开或者收回后将菜单的状态传递给父组件，值为数组时表示分别控制左右滑动的展开和收起状态 | N
 onClick | Function |  | TS 类型：`(action: SwipeActionItem, source: SwipeSource) => void`<br/>操作项点击时触发（插槽写法组件不触发，业务侧自定义内容和事件）。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/swipe-cell/type.ts)。<br/>`type SwipeSource = 'left' \| 'right'`<br/> | N

packages/products/tdesign-mobile-react/src/swipe-cell/swipe-cell.md

@@ -4,7 +4,7 @@
  * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
  * */
 
-import { TNode } from '../common';
+import { TNode, Styles } from '../common';
 
 export interface TdSwipeCellProps {
   /**
@@ -41,10 +41,12 @@ export interface TdSwipeCellProps {
 export interface SwipeActionItem {
   text: string;
   className?: string;
-  style?: string;
-  sure?: string | TNode;
+  style?: Styles;
+  sure?: Sure;
   onClick?: () => void;
   [key: string]: any;
 }
 
+export type Sure = string | TNode;
+
 export type SwipeSource = 'left' | 'right';

packages/products/tdesign-mobile-react/src/swipe-cell/type.ts

@@ -2,7 +2,6 @@
 
 ## API
 
-
 ### Swiper Props
 
 name | type | default | description | required
@@ -14,21 +13,22 @@ autoplay | Boolean | true | \- | N
 current | Number | 0 | \- | N
 direction | String | horizontal | options: horizontal/vertical | N
 duration | Number | 300 | \- | N
-height | Number | - | \- | N
+height | String / Number | - | \- | N
 interval | Number | 5000 | \- | N
 loop | Boolean | true | \- | N
 navigation | TNode | - | Typescript：`SwiperNavigation \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
 nextMargin | String / Number | 0 | \- | N
 previousMargin | String / Number | 0 | \- | N
 type | String | default | options: default/card | N
-onChange | Function |  | Typescript：`(current: number, context: { source: SwiperChangeSource }) => void`<br/>[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/swiper/type.ts)。<br/>`type SwiperChangeSource = 'autoplay' \| 'touch' \| ''`<br/> | N
+onChange | Function |  | Typescript：`(current: number, context: { source: SwiperChangeSource }) => void`<br/>[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/swiper/type.ts)。<br/>`type SwiperChangeSource = 'autoplay' \| 'touch' \| 'nav'`<br/> | N
 onClick | Function |  | Typescript：`(index: number) => void`<br/> | N
 
 ### SwiperNavigation
 
 name | type | default | description | required
 -- | -- | -- | -- | --
 minShowNum | Number | - | \- | N
-paginationPosition | String | bottom | options: top-left/top/top-right/bottom-left/bottom/bottom-right | N
+paginationPosition | String | bottom | options: top-left/top/top-right/bottom-left/bottom/bottom-right/left/right | N
+placement | String | inside | options: inside/outside | N
 showControls | Boolean | false | \- | N
 type | String | - | Typescript：`SwiperNavigationType` `type SwiperNavigationType = 'dots' \| 'dots-bar' \| 'fraction'`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/swiper/type.ts) | N

packages/products/tdesign-mobile-react/src/swiper/swiper.en-US.md

@@ -2,7 +2,6 @@
 
 ## API
 
-
 ### Swiper Props
 
 名称 | 类型 | 默认值 | 描述 | 必传
@@ -14,21 +13,22 @@ autoplay | Boolean | true | 是否自动播放 | N
 current | Number | 0 | 当前轮播在哪一项（下标） | N
 direction | String | horizontal | 轮播滑动方向，包括横向滑动和纵向滑动两个方向。可选项：horizontal/vertical | N
 duration | Number | 300 | 滑动动画时长 | N
-height | Number | - | 当使用垂直方向滚动时的高度 | N
+height | String / Number | - | 当使用垂直方向滚动时的高度 | N
 interval | Number | 5000 | 轮播间隔时间 | N
 loop | Boolean | true | 是否循环播放 | N
 navigation | TNode | - | 导航器全部配置。TS 类型：`SwiperNavigation \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
 nextMargin | String / Number | 0 | 后边距，可用于露出后一项的一小部分。默认单位 `px` | N
 previousMargin | String / Number | 0 | 前边距，可用于露出前一项的一小部分。默认单位 `px` | N
 type | String | default | 样式类型：默认样式、卡片样式。可选项：default/card | N
-onChange | Function |  | TS 类型：`(current: number, context: { source: SwiperChangeSource }) => void`<br/>轮播切换时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/swiper/type.ts)。<br/>`type SwiperChangeSource = 'autoplay' \| 'touch' \| ''`<br/> | N
+onChange | Function |  | TS 类型：`(current: number, context: { source: SwiperChangeSource }) => void`<br/>轮播切换时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/swiper/type.ts)。<br/>`type SwiperChangeSource = 'autoplay' \| 'touch' \| 'nav'`<br/> | N
 onClick | Function |  | TS 类型：`(index: number) => void`<br/>点击轮播项时触发 | N
 
 ### SwiperNavigation
 
 名称 | 类型 | 默认值 | 描述 | 必传
 -- | -- | -- | -- | --
 minShowNum | Number | - | 小于这个数字不会显示导航器 | N
-paginationPosition | String | bottom | 页码信息展示位置。可选项：top-left/top/top-right/bottom-left/bottom/bottom-right | N
+paginationPosition | String | bottom | 页码信息展示位置。可选项：top-left/top/top-right/bottom-left/bottom/bottom-right/left/right | N
+placement | String | inside | 导航器位置，位于主体的内侧或是外侧。可选项：inside/outside | N
 showControls | Boolean | false | 是否显示两侧的控制按钮 | N
 type | String | - | 导航器类型，点状(dots)、点条状(dots-bar)、分式(fraction)等。TS 类型：`SwiperNavigationType` `type SwiperNavigationType = 'dots' \| 'dots-bar' \| 'fraction'`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/swiper/type.ts) | N