From 8490ead9992e52426896569af71a7289ebd7b516 Mon Sep 17 00:00:00 2001 From: anlyyao Date: Wed, 25 Mar 2026 18:34:50 +0800 Subject: [PATCH] docs(ImageViewer): add swipeTo func --- db/TDesign.db | Bin 1130496 -> 1130496 bytes .../src/image-viewer/image-viewer.en-US.md | 6 +++ .../src/image-viewer/image-viewer.md | 6 +++ .../src/image-viewer/type.ts | 9 +++++ .../src/swiper/swiper.en-US.md | 1 + .../tdesign-mobile-vue/src/swiper/swiper.md | 1 + .../tdesign-mobile-vue/src/swiper/type.ts | 5 +++ packages/scripts/api.json | 35 ++++++++++++++++++ 8 files changed, 63 insertions(+) diff --git a/db/TDesign.db b/db/TDesign.db index 336ea3bf450ccedd3e68c473034651071bb5abae..c058da2e798e9d17d75391a5d45225a913f98b40 100644 GIT binary patch delta 538 zcmZo@aBXOCogmHlcA|_k>stoBvaXFOQ!Uwf7#J9Z7O^y0wOKK?SuwR)F>kYCdA5L2 zxc&Jp79eH?Vm2UV2VxE&<^*CcAm#>Q9w6r3{`?l-s>_TL(|zxz1WFFq0Dk#dy z%)*p;cq_Z0$aWupfvpEv*o_%DwzCQd>anwM>oOT{Hy0N?%OS(T@{57Bo#hv=Bu^mM z4$j{kli0;rRmvreHqDJGQ!Uwr7#J9Z7O^#1wOKK?SuwR)F>kYCdA5Mj zy#4tt79eH?Vm2UV2VxE&<^*CcAm#>Q9w6r3{`?l-s>_T5(|zx`type ImageViewerCloseTrigger = 'image' \| 'overlay' \| 'close-btn'`
delete | `(index: number)` | \- index-change | `(index: number, context: { trigger: 'prev' \| 'next' })` | \- + +### ImageViewerInstanceFunctions 组件实例方法 + +name | params | return | description +-- | -- | -- | -- +swipeTo | `(index: number, options?: SwiperToOptions)` | \- | `1.13.2`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/image-viewer/type.ts)。
`import { SwiperToOptions } from '@Swiper'`
diff --git a/packages/products/tdesign-mobile-vue/src/image-viewer/image-viewer.md b/packages/products/tdesign-mobile-vue/src/image-viewer/image-viewer.md index cce345b97..17e96d998 100644 --- a/packages/products/tdesign-mobile-vue/src/image-viewer/image-viewer.md +++ b/packages/products/tdesign-mobile-vue/src/image-viewer/image-viewer.md @@ -28,3 +28,9 @@ onIndexChange | Function | | TS 类型：`(index: number, context: { trigger: ' close | `(context: { trigger: ImageViewerCloseTrigger, visible: boolean, index: number })` | 关闭时触发。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/image-viewer/type.ts)。
`type ImageViewerCloseTrigger = 'image' \| 'overlay' \| 'close-btn'`
delete | `(index: number)` | 点击删除操作按钮时触发 index-change | `(index: number, context: { trigger: 'prev' \| 'next' })` | 预览图片切换时触发，`context.prev` 切换到上一张图片，`context.next` 切换到下一张图片 + +### ImageViewerInstanceFunctions 组件实例方法 + +名称 | 参数 | 返回值 | 描述 +-- | -- | -- | -- +swipeTo | `(index: number, options?: SwiperToOptions)` | \- | `1.13.2`。切换到指定预览图片位置。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/image-viewer/type.ts)。
`import { SwiperToOptions } from '@Swiper'`
diff --git a/packages/products/tdesign-mobile-vue/src/image-viewer/type.ts b/packages/products/tdesign-mobile-vue/src/image-viewer/type.ts index 5c1ca7b1d..ffd7af76a 100644 --- a/packages/products/tdesign-mobile-vue/src/image-viewer/type.ts +++ b/packages/products/tdesign-mobile-vue/src/image-viewer/type.ts @@ -4,6 +4,7 @@ * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC * */ +import { SwiperToOptions } from '../swiper'; import type { TNode } from '../common'; export interface TdImageViewerProps { @@ -77,6 +78,14 @@ export interface TdImageViewerProps { onIndexChange?: (index: number, context: { trigger: 'prev' | 'next' }) => void; } +/** 组件实例方法 */ +export interface ImageViewerInstanceFunctions { + /** + * 切换到指定预览图片位置 + */ + swipeTo?: (index: number, options?: SwiperToOptions) => void; +} + export interface ImageSlotParams { src: string; className?: string; diff --git a/packages/products/tdesign-mobile-vue/src/swiper/swiper.en-US.md b/packages/products/tdesign-mobile-vue/src/swiper/swiper.en-US.md index 915999211..0cb97b697 100644 --- a/packages/products/tdesign-mobile-vue/src/swiper/swiper.en-US.md +++ b/packages/products/tdesign-mobile-vue/src/swiper/swiper.en-US.md @@ -34,5 +34,6 @@ name | type | default | description | required -- | -- | -- | -- | -- minShowNum | Number | - | \- | 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-vue/tree/develop/src/swiper/type.ts) | N diff --git a/packages/products/tdesign-mobile-vue/src/swiper/swiper.md b/packages/products/tdesign-mobile-vue/src/swiper/swiper.md index 8ecae1acb..d322a552c 100644 --- a/packages/products/tdesign-mobile-vue/src/swiper/swiper.md +++ b/packages/products/tdesign-mobile-vue/src/swiper/swiper.md @@ -34,5 +34,6 @@ click | `(index: number)` | 点击轮播项时触发 -- | -- | -- | -- | -- minShowNum | Number | - | 小于这个数字不会显示导航器 | 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-vue/tree/develop/src/swiper/type.ts) | N diff --git a/packages/products/tdesign-mobile-vue/src/swiper/type.ts b/packages/products/tdesign-mobile-vue/src/swiper/type.ts index f63303c89..0879dd75a 100644 --- a/packages/products/tdesign-mobile-vue/src/swiper/type.ts +++ b/packages/products/tdesign-mobile-vue/src/swiper/type.ts @@ -90,6 +90,11 @@ export interface SwiperNavigation { * @default bottom */ paginationPosition?: 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right' | 'left' | 'right'; + /** + * 导航器位置，位于主体的内侧或是外侧 + * @default inside + */ + placement?: 'inside' | 'outside'; /** * 是否显示两侧的控制按钮 * @default false diff --git a/packages/scripts/api.json b/packages/scripts/api.json index 50f95d126..a5a73d41d 100644 --- a/packages/scripts/api.json +++ b/packages/scripts/api.json @@ -74249,6 +74249,39 @@ ], "field_type_text": [] }, + { + "id": 1774433543, + "platform_framework": [ + "8" + ], + "component": "ImageViewer", + "field_category": 4, + "field_name": "swipeTo", + "field_type": [], + "field_default_value": "", + "field_enum": "", + "field_desc_zh": "切换到指定预览图片位置", + "field_desc_en": null, + "field_required": 0, + "event_input": "(index: number, options?: SwiperToOptions)【import { SwiperToOptions } from '@Swiper'】", + "create_time": "2026-03-25 10:12:23", + "update_time": "2026-03-25 10:12:23", + "event_output": null, + "custom_field_type": null, + "syntactic_sugar": null, + "readonly": 1, + "html_attribute": 0, + "trigger_elements": "", + "deprecated": 0, + "version": "{\n\"Vue(Mobile)\": \"1.13.2\"\n}", + "test_description": null, + "support_default_value": 0, + "field_category_text": "Functions", + "platform_framework_text": [ + "Vue(Mobile)" + ], + "field_type_text": [] + }, { "id": 1759199178, "platform_framework": [ @@ -125071,6 +125104,7 @@ { "id": 1734341852, "platform_framework": [ + "8", "16" ], "component": "SwiperNavigation", @@ -125099,6 +125133,7 @@ "support_default_value": 0, "field_category_text": "Props", "platform_framework_text": [ + "Vue(Mobile)", "React(Mobile)" ], "field_type_text": [