Skip to content
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.

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

feat(ImageViewer): add download callback #3408

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/components/common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { ReactElement, ReactNode, CSSProperties, FormEvent, DragEvent, Synthetic
// TElement 表示 API 只接受传入组件
export type TElement<T = undefined> = T extends undefined ? ReactElement : (props: T) => ReactElement;
// 1. TNode = ReactNode; 2. TNode<T> = (props: T) => ReactNode
export type TNode<T = undefined> = T extends undefined ? ReactNode : ReactNode | ((props: T) => ReactNode);
export type TNode<T = undefined> = T extends undefined ? ReactNode | (() => ReactNode) : ReactNode | ((props: T) => ReactNode);

export type AttachNodeReturnValue = HTMLElement | Element | Document;
export type AttachNode = CSSSelector | ((triggerNode?: HTMLElement) => AttachNodeReturnValue);
Expand Down
1 change: 1 addition & 0 deletions packages/components/image-viewer/ImageViewer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ const ImageViewer: React.FC<ImageViewerProps> = (originalProps) => {
defaultIndex={props.defaultIndex}
index={props.index}
onIndexChange={props.onIndexChange}
onDownload={props.onDownload}
draggable={props.draggable}
closeOnOverlay={props.closeOnOverlay}
closeBtn={props.closeBtn}
Expand Down
10 changes: 10 additions & 0 deletions packages/components/image-viewer/ImageViewerModal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@ interface ImageViewerUtilsProps {
rotate: string;
originsize: string;
};
onDownload?:TdImageViewerProps['onDownload'];
}

export const ImageViewerUtils: React.FC<ImageViewerUtilsProps> = ({
Expand All @@ -245,6 +246,7 @@ export const ImageViewerUtils: React.FC<ImageViewerUtilsProps> = ({
onMirror,
onReset,
tipText,
onDownload,
}) => {
const { classPrefix } = useConfig();
const { MirrorIcon, RotationIcon, ImageIcon } = useGlobalIcon({
Expand Down Expand Up @@ -293,6 +295,11 @@ export const ImageViewerUtils: React.FC<ImageViewerUtilsProps> = ({
size="medium"
name="download"
onClick={() => {
if(isFunction(onDownload)){
// 自定义图片预览下载
onDownload(currentImage.mainImage);
return;
}
downloadFile(currentImage.mainImage);
}}
/>
Expand Down Expand Up @@ -387,6 +394,7 @@ export interface ImageModalProps {
draggable: boolean;
closeBtn: boolean | TNode;
closeOnEscKeydown?: boolean;
onDownload?:TdImageViewerProps['onDownload'];
onIndexChange?: (index: number, context: { trigger: 'prev' | 'next' }) => void;
imageReferrerpolicy?: ImageViewerProps['imageReferrerpolicy'];
}
Expand All @@ -409,6 +417,7 @@ export const ImageModal: React.FC<ImageModalProps> = (props) => {
title,
closeOnEscKeydown,
imageReferrerpolicy,
onDownload,
...resProps
} = props;
const { classPrefix } = useConfig();
Expand Down Expand Up @@ -572,6 +581,7 @@ export const ImageModal: React.FC<ImageModalProps> = (props) => {
onZoomOut={onZoomOut}
scale={scale}
currentImage={currentImage}
onDownload={onDownload}
onRotate={onRotate}
onMirror={onMirror}
onReset={onReset}
Expand Down
1 change: 1 addition & 0 deletions packages/components/image-viewer/defaultProps.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import { TdImageViewerProps } from './type';

export const imageViewerDefaultProps: TdImageViewerProps = {
attach: 'body',
closeBtn: true,
closeOnEscKeydown: true,
draggable: undefined,
Expand Down
1 change: 1 addition & 0 deletions packages/components/image-viewer/image-viewer.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,5 @@ visible | Boolean | false | hide or show image viewer | N
defaultVisible | Boolean | false | hide or show image viewer。uncontrolled property | N
zIndex | Number | - | \- | N
onClose | Function | | Typescript:`(context: { trigger: 'close-btn' \| 'overlay' \| 'esc'; e: MouseEvent \| KeyboardEvent }) => void`<br/> | N
onDownload | Function | | Typescript:`(url: string \| File) => void`<br/> | N
onIndexChange | Function | | Typescript:`(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`<br/> | N
3 changes: 2 additions & 1 deletion packages/components/image-viewer/image-viewer.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
-- | -- | -- | -- | --
className | String | - | 类名 | N
style | Object | - | 样式,TS 类型:`React.CSSProperties` | N
attach | String / Function | 'body' | 制定挂载节点。数据类型为 String 时,会被当作选择器处理,进行节点查询。示例:'body' 或 () => document.body。TS 类型:`AttachNode`[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
attach | String / Function | 'body' | 指定挂载节点。数据类型为 String 时,会被当作选择器处理,进行节点查询。示例:'body' 或 () => document.body。TS 类型:`AttachNode`[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
closeBtn | TNode | true | 是否展示关闭按钮,值为 `true` 显示默认关闭按钮;值为 `false` 则不显示关闭按钮;也可以完全自定义关闭按钮。TS 类型:`boolean \| TNode`[通用类型定义](https://github.com/Tencent/tdesign-react/blob/develop/packages/components/common.ts) | N
closeOnEscKeydown | Boolean | true | 按下 ESC 时是否触发图片预览器关闭事件 | N
closeOnOverlay | Boolean | - | 是否在点击遮罩层时,触发预览关闭 | N
Expand All @@ -28,4 +28,5 @@ visible | Boolean | false | 隐藏/显示预览 | N
defaultVisible | Boolean | false | 隐藏/显示预览。非受控属性 | N
zIndex | Number | - | 层级,默认为 2000 | N
onClose | Function | | TS 类型:`(context: { trigger: 'close-btn' \| 'overlay' \| 'esc'; e: MouseEvent \| KeyboardEvent }) => void`<br/>关闭时触发,事件参数包含触发关闭的来源:关闭按钮、遮罩层、ESC 键 | N
onDownload | Function | | TS 类型:`(url: string \| File) => void`<br/>自定义预览图片下载操作,url为图片链接 | N
onIndexChange | Function | | TS 类型:`(index: number, context: { trigger: 'prev' \| 'next' \| 'current' }) => void`<br/>预览图片切换时触发,`context.prev` 切换到上一张图片,`context.next` 切换到下一张图片 | N
6 changes: 5 additions & 1 deletion packages/components/image-viewer/type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { MouseEvent, KeyboardEvent } from 'react';

export interface TdImageViewerProps {
/**
* 制定挂载节点。数据类型为 String 时,会被当作选择器处理,进行节点查询。示例:'body' 或 () => document.body
* 指定挂载节点。数据类型为 String 时,会被当作选择器处理,进行节点查询。示例:'body' 或 () => document.body
* @default 'body'
*/
attach?: AttachNode;
Expand Down Expand Up @@ -106,6 +106,10 @@ export interface TdImageViewerProps {
* 关闭时触发,事件参数包含触发关闭的来源:关闭按钮、遮罩层、ESC 键
*/
onClose?: (context: { trigger: 'close-btn' | 'overlay' | 'esc'; e: MouseEvent<HTMLElement> | KeyboardEvent }) => void;
/**
* 自定义预览图片下载操作,url为图片链接
*/
onDownload?: (url: string | File) => void;
/**
* 预览图片切换时触发,`context.prev` 切换到上一张图片,`context.next` 切换到下一张图片
*/
Expand Down
Loading