Skip to content

feat(image-viewer): enable props image-props #780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anlyyao merged 2 commits into from
Dec 3, 2025
Merged

feat(image-viewer): enable props image-props #780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
beb58dd
feat(image-viewer): enable props show-menu-by-longpress
betavs Nov 27, 2025
d2f6c80
feat(image-viewer): enable props image-props
betavs Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified db/TDesign.db
View file
Open in desktop
Binary file not shown.
5 changes: 3 additions & 2 deletions ...s/products/tdesign-miniprogram/packages/components/image-viewer/README.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on v
background-color | String | - | \- | N
close-btn | String / Boolean / Object | false | \- | N
delete-btn | String / Boolean / Object | false | \- | N
images | Array | [] | Typescript：`Array<string>` | N
initial-index | Number | 0 | Typescript：`Number` | N
image-props | Object | - | `1.12.0`。Typescript: `ImageProps`，[Image API Documents](./image?tab=api)。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/image-viewer/type.ts) | N
images | Array | [] | Typescript: `Array<string>` | N
initial-index | Number | 0 | Typescript: `Number` | N
lazy | Boolean | true | `1.9.4` | N
show-index | Boolean | false | \- | N
using-custom-navbar | Boolean | false | `v1.1.4` | N
Expand Down
1 change: 1 addition & 0 deletions packages/products/tdesign-miniprogram/packages/components/image-viewer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场
background-color | String | - | 遮罩的背景颜色 | N
close-btn | String / Boolean / Object | false | 是否显示关闭操作，前提需要开启页码。值为字符串表示图标名称，值为 `true` 表示使用默认图标 `close`，值为 `Object` 类型，表示透传至 `icon` ，不传表示不显示图标 | N
delete-btn | String / Boolean / Object | false | 是否显示删除操作，前提需要开启页码。值为字符串表示图标名称，值为 `true` 表示使用默认图标 `delete`，值为 `Object` 类型，表示透传至 `icon`，不传表示不显示图标 | N
image-props | Object | - | `1.12.0`。透传至 Image 组件。TS 类型：`ImageProps`，[Image API Documents](./image?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/image-viewer/type.ts) | N
images | Array | [] | 图片数组。TS 类型：`Array<string>` | N
initial-index | Number | 0 | 初始化页码。TS 类型：`Number` | N
lazy | Boolean | true | `1.9.4`。是否开启图片懒加载。开启后会预加载当前图片、相邻图片 | N
Expand Down
4 changes: 4 additions & 0 deletions packages/products/tdesign-miniprogram/packages/components/image-viewer/props.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ const props: TdImageViewerProps = {
type: null,
value: false,
},
/** 透传至 Image 组件 */
imageProps: {
type: Object,
},
/** 图片数组 */
images: {
type: Array,
Expand Down
9 changes: 9 additions & 0 deletions packages/products/tdesign-miniprogram/packages/components/image-viewer/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
* 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
* */

import { ImageProps } from '../image/index';

export interface TdImageViewerProps {
/**
* 遮罩的背景颜色
Expand All @@ -29,6 +31,13 @@ export interface TdImageViewerProps {
type: null;
value?: string | boolean | object;
};
/**
* 透传至 Image 组件
*/
imageProps?: {
type: ObjectConstructor;
value?: ImageProps;
};
/**
* 图片数组
* @default []
Expand Down
37 changes: 37 additions & 0 deletions packages/scripts/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68865,6 +68865,43 @@
"Boolean"
]
},
{
"id": 1764210910,
"platform_framework": [
"64"
],
"component": "ImageViewer",
"field_category": 1,
"field_name": "imageProps",
"field_type": [
"8"
],
"field_default_value": "",
"field_enum": "",
"field_desc_zh": "透传至 Image 组件",
"field_desc_en": null,
"field_required": 0,
"event_input": "",
"create_time": "2025-11-27 02:35:10",
"update_time": "2025-11-27 02:35:10",
"event_output": null,
"custom_field_type": "ImageProps【import { ImageProps } from '@Image'】",
"syntactic_sugar": null,
"readonly": 1,
"html_attribute": 0,
"trigger_elements": "",
"deprecated": 0,
"version": "{ \"Miniprogram\": \"1.12.0\" }",
"test_description": null,
"support_default_value": 0,
"field_category_text": "Props",
"platform_framework_text": [
"Miniprogram"
],
"field_type_text": [
"Object"
]
},
{
"id": 1711596997,
"platform_framework": [
Expand Down