feat(Swiper): update api docs (#1945)

* feat(Swiper): update api docs * Update CHANGELOG.md
Tencent · Apr 28, 2023 · c977ec5 · c977ec5
1 parent 348ba4c
commit c977ec5
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,7 @@ docClass: timeline
 ## 🌈 1.1.2 `2023-04-17` 
 ### 🚀 Features
 - `Swiper`: 支持无障碍访问 @zhangpaopao0609 ([#1598](https://github.com/Tencent/tdesign-miniprogram/pull/1598))
+- `Swiper`: list 属性支持 SwiperList[] 类型 @zhangpaopao0609 ([#1598](https://github.com/Tencent/tdesign-miniprogram/pull/1598))
 - `Divider`: 新增 CSS Variables 用于控制分割线样式 @favouredddd ([#1890](https://github.com/Tencent/tdesign-miniprogram/pull/1890))
 - `Grid`: 补充 CSS Variables 以修改不同列数下的图片尺寸和文字大小 @lolhezihehe ([#1903](https://github.com/Tencent/tdesign-miniprogram/pull/1903))
 - `Radio`: 新增 CSS Variables 用于控制内容字体大小 @favouredddd ([#1895](https://github.com/Tencent/tdesign-miniprogram/pull/1895))

diff --git a/src/swiper-nav/type.ts b/src/swiper-nav/type.ts
@@ -13,14 +13,6 @@ export interface TdSwiperNavProps {
     type: NumberConstructor;
     value?: number;
   };
-  /**
-   * 自定义组件样式
-   * @default ''
-   */
-  style?: {
-    type: StringConstructor;
-    value?: string;
-  };
   /**
    * 轮播滑动方向，包括横向滑动和纵向滑动两个方向
    * @default horizontal

diff --git a/src/swiper/README.en-US.md b/src/swiper/README.en-US.md
@@ -14,7 +14,7 @@ easing-function | String | default | `0.32.0`。options：default/linear/easeInC
 height | String / Number | 192 | \- | N
 image-props | Object | - | `0.34.0` | N
 interval | Number | 5000 | \- | N
-list | Array | - | `0.32.0`。Typescript：`string[]` | N
+list | Array | - | `0.32.0`。Typescript：`string[] \| SwiperList[]` `interface SwiperList { value: string, ariaLabel: string }`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/swiper/type.ts) | N
 loop | Boolean | true | \- | N
 navigation | Boolean / Object / Slot | true | Typescript：`SwiperNavProps \| boolean`，[SwiperNav API Documents](./swiper-nav?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/swiper/type.ts) | N
 next-margin | String / Number | 0 | `0.32.0` | N

diff --git a/src/swiper/README.md b/src/swiper/README.md
@@ -69,7 +69,7 @@ easing-function | String | default | `0.32.0`。指定 swiper 切换缓动动画
 height | String / Number | 192 | 轮播的高度；默认单位 `px` | N
 image-props | Object | - | `0.34.0`。透传至 Image 组件 | N
 interval | Number | 5000 | 轮播间隔时间 | N
-list | Array | - | `0.32.0`。图片列表。TS 类型：`string[]` | N
+list | Array | - | `0.32.0`。图片列表。TS 类型：`string[] \| SwiperList[]` `interface SwiperList { value: string, ariaLabel: string }`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/swiper/type.ts) | N
 loop | Boolean | true | 是否循环播放 | N
 navigation | Boolean / Object / Slot | true | 导航器全部配置，true 的话使用默认配置。TS 类型：`SwiperNavProps \| boolean`，[SwiperNav API Documents](./swiper-nav?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/swiper/type.ts) | N
 next-margin | String / Number | 0 | `0.32.0`。后边距，可用于露出后一项的一小部分。默认单位 `px` | N

diff --git a/src/swiper/type.ts b/src/swiper/type.ts
@@ -23,14 +23,6 @@ export interface TdSwiperProps {
     type: NumberConstructor;
     value?: number;
   };
-  /**
-   * 自定义组件样式
-   * @default ''
-   */
-  style?: {
-    type: StringConstructor;
-    value?: string;
-  };
   /**
    * 轮播滑动方向，包括横向滑动和纵向滑动两个方向
    * @default horizontal
@@ -91,7 +83,7 @@ export interface TdSwiperProps {
    */
   list?: {
     type: ArrayConstructor;
-    value?: string[];
+    value?: string[] | SwiperList[];
   };
   /**
    * 是否循环播放
@@ -142,3 +134,8 @@ export interface TdSwiperProps {
     value?: boolean;
   };
 }
+
+export interface SwiperList {
+  value: string;
+  ariaLabel: string;
+}