Skip to content

feat: support classnames and styles #378

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

Merged
merged 3 commits into from
Mar 5, 2025
Merged
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
12 changes: 10 additions & 2 deletions src/Image.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ export interface ImagePreviewType
getContainer?: GetContainer | false;
mask?: React.ReactNode;
maskClassName?: string;
classNames?: Partial<Record<SemanticName, string>>;
styles?: Partial<Record<SemanticName, React.CSSProperties>>;
icons?: PreviewProps['icons'];
scaleStep?: number;
movable?: boolean;
Expand All @@ -49,6 +51,8 @@ export interface ImagePreviewType
) => React.ReactNode;
}

export type SemanticName = 'root' | 'actions' | 'mask';

export interface ImageProps
extends Omit<React.ImgHTMLAttributes<HTMLImageElement>, 'placeholder' | 'onClick'> {
// Original
Expand Down Expand Up @@ -92,7 +96,6 @@ const ImageInternal: CompoundedComponent<ImageProps> = props => {
wrapperClassName,
wrapperStyle,
rootClassName,

...otherProps
} = props;

Expand All @@ -104,6 +107,8 @@ const ImageInternal: CompoundedComponent<ImageProps> = props => {
getContainer: getPreviewContainer = undefined,
mask: previewMask,
maskClassName,
classNames: imageClassNames,
styles,
movable,
icons,
scaleStep,
Expand Down Expand Up @@ -222,9 +227,10 @@ const ImageInternal: CompoundedComponent<ImageProps> = props => {
{/* Preview Click Mask */}
{previewMask && canPreview && (
<div
className={cn(`${prefixCls}-mask`, maskClassName)}
className={cn(`${prefixCls}-mask`, maskClassName, imageClassNames?.mask)}
style={{
display: style?.display === 'none' ? 'none' : undefined,
...styles?.mask,
}}
>
{previewMask}
Expand Down Expand Up @@ -252,6 +258,8 @@ const ImageInternal: CompoundedComponent<ImageProps> = props => {
imageRender={imageRender}
imgCommonProps={imgCommonProps}
toolbarRender={toolbarRender}
classNames={imageClassNames}
styles={styles}
{...dialogProps}
/>
)}
Expand Down
12 changes: 10 additions & 2 deletions src/Operations.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ import CSSMotion from 'rc-motion';
import KeyCode from 'rc-util/lib/KeyCode';
import * as React from 'react';
import { useContext } from 'react';
import type { ImgInfo } from './Image';
import type { ImgInfo, SemanticName } from './Image';
import type { PreviewProps, ToolbarRenderInfoType } from './Preview';
import { PreviewGroupContext } from './context';
import type { TransformType } from './hooks/useImageTransform';
import classNames from 'classnames';

type OperationType =
| 'prev'
Expand Down Expand Up @@ -61,6 +62,8 @@ interface OperationsProps
) => React.ReactNode;
zIndex?: number;
image?: ImgInfo;
classNames?: Partial<Record<SemanticName, string>>;
styles?: Partial<Record<SemanticName, React.CSSProperties>>;
}

const Operations: React.FC<OperationsProps> = props => {
Expand Down Expand Up @@ -93,6 +96,8 @@ const Operations: React.FC<OperationsProps> = props => {
toolbarRender,
zIndex,
image,
classNames: imageClassNames,
styles,
} = props;
const groupContext = useContext(PreviewGroupContext);
const { rotateLeft, rotateRight, zoomIn, zoomOut, close, left, right, flipX, flipY } = icons;
Expand Down Expand Up @@ -195,7 +200,10 @@ const Operations: React.FC<OperationsProps> = props => {
});

const toolbarNode = (
<div className={`${prefixCls}-operations`}>
<div
className={classNames(`${prefixCls}-operations`, imageClassNames?.actions)}
style={styles?.actions}
>
{flipYNode}
{flipXNode}
{rotateLeftNode}
Expand Down
28 changes: 22 additions & 6 deletions src/Preview.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import Dialog from 'rc-dialog';
import addEventListener from 'rc-util/lib/Dom/addEventListener';
import KeyCode from 'rc-util/lib/KeyCode';
import React, { useContext, useEffect, useRef, useState } from 'react';
import type { ImgInfo } from './Image';
import type { ImgInfo, SemanticName } from './Image';
import Operations from './Operations';
import { PreviewGroupContext } from './context';
import type { TransformAction, TransformType } from './hooks/useImageTransform';
Expand Down Expand Up @@ -42,7 +42,7 @@ export type ToolbarRenderInfoType = {
image: ImgInfo;
};

export interface PreviewProps extends Omit<IDialogPropTypes, 'onClose'> {
export interface PreviewProps extends Omit<IDialogPropTypes, 'onClose' | 'styles' | 'classNames'> {
imgCommonProps?: React.ImgHTMLAttributes<HTMLImageElement>;
src?: string;
alt?: string;
Expand Down Expand Up @@ -82,6 +82,11 @@ export interface PreviewProps extends Omit<IDialogPropTypes, 'onClose'> {
info: ToolbarRenderInfoType,
) => React.ReactNode;
onChange?: (current, prev) => void;
classNames?: Partial<Record<SemanticName, string>>;
styles?: Partial<Record<SemanticName, React.CSSProperties>> & {
/** Temporarily used in PurePanel, not used externally by antd */
wrapper?: React.CSSProperties;
};
}

interface PreviewImageProps extends React.ImgHTMLAttributes<HTMLImageElement> {
Expand Down Expand Up @@ -134,6 +139,8 @@ const Preview: React.FC<PreviewProps> = props => {
toolbarRender,
onTransform,
onChange,
classNames: imageClassNames,
styles,
...restProps
} = props;

Expand Down Expand Up @@ -220,7 +227,7 @@ const Preview: React.FC<PreviewProps> = props => {
setEnableTransition(false);
resetTransform(offset < 0 ? 'prev' : 'next');
onChange?.(position, current);
}
};

const onKeyDown = (event: KeyboardEvent) => {
if (!visible || !showLeftOrRightSwitches) return;
Expand Down Expand Up @@ -264,8 +271,9 @@ const Preview: React.FC<PreviewProps> = props => {
className={`${prefixCls}-img`}
alt={alt}
style={{
transform: `translate3d(${transform.x}px, ${transform.y}px, 0) scale3d(${transform.flipX ? '-' : ''
}${scale}, ${transform.flipY ? '-' : ''}${scale}, 1) rotate(${rotate}deg)`,
transform: `translate3d(${transform.x}px, ${transform.y}px, 0) scale3d(${
transform.flipX ? '-' : ''
}${scale}, ${transform.flipY ? '-' : ''}${scale}, 1) rotate(${rotate}deg)`,
transitionDuration: (!enableTransition || isTouching) && '0s',
}}
fallback={fallback}
Expand Down Expand Up @@ -298,8 +306,14 @@ const Preview: React.FC<PreviewProps> = props => {
visible={visible}
classNames={{
wrapper: wrapClassName,
mask: imageClassNames?.mask,
}}
rootClassName={rootClassName}
styles={{
mask: styles?.mask,
wrapper: styles?.wrapper,
}}
style={styles?.root}
rootClassName={classnames(rootClassName, imageClassNames?.root)}
getContainer={getContainer}
{...restProps}
afterClose={onAfterClose}
Expand Down Expand Up @@ -339,6 +353,8 @@ const Preview: React.FC<PreviewProps> = props => {
onReset={onReset}
zIndex={restProps.zIndex !== undefined ? restProps.zIndex + 1 : undefined}
image={image}
classNames={imageClassNames}
styles={styles}
/>
</>
);
Expand Down
32 changes: 32 additions & 0 deletions tests/preview.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -1030,4 +1030,36 @@ describe('Preview', () => {
expect(previewImg).not.toHaveAttribute('width');
expect(previewImg).not.toHaveAttribute('height');
});
it('support classnames and styles', () => {
const customClassnames = {
mask: 'custom-mask',
actions: 'custom-actions',
root: 'custom-root',
};
const customStyles = {
mask: { color: 'red' },
actions: { backgroundColor: 'blue' },
root: { border: '1px solid green' },
};
const { baseElement } = render(
<Image
src="https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png"
preview={{
styles: customStyles,
classNames: customClassnames,
mask: 'Bamboo Is Light',
zIndex: 9999,
visible: true,
}}
/>,
);
const mask = document.querySelector('.rc-image-mask');
const actions = baseElement.querySelector('.rc-image-preview-operations');
expect(mask).toHaveClass(customClassnames.mask);
expect(mask).toHaveStyle(customStyles.mask);
expect(actions).toHaveClass(customClassnames.actions);
expect(actions).toHaveStyle(customStyles.actions);
expect(baseElement.querySelector('.rc-image-preview-root')).toHaveClass(customClassnames.root);
expect(baseElement.querySelector('.rc-image-preview')).toHaveStyle(customStyles.root);
});
});