Skip to content

fix: 修复 PreviewGroup preview={false} 无法禁用预览的问题 #536

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

Open
dogledogle wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix: 修复 PreviewGroup preview={false} 无法禁用预览的问题 #536

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
d0da14a
fix: disable group preview when preview is false or null
dogledogle Oct 21, 2026
ed90229
fix: reset uncontrolled open state when group preview is disabled
dogledogle Oct 21, 2026
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
10 changes: 6 additions & 4 deletions src/Image.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,10 @@ export interface PreviewConfig extends Omit<InternalPreviewConfig, 'countRender'

export type SemanticName = 'root' | 'image' | 'cover';

export interface ImageProps
extends Omit<React.ImgHTMLAttributes<HTMLImageElement>, 'placeholder' | 'onClick' | 'onKeyDown'> {
export interface ImageProps extends Omit<
React.ImgHTMLAttributes<HTMLImageElement>,
'placeholder' | 'onClick' | 'onKeyDown'
> {
// Misc
prefixCls?: string;
previewPrefixCls?: string;
Expand Down Expand Up @@ -116,7 +118,7 @@ const ImageInternal: CompoundedComponent<ImageProps> = props => {
const groupContext = useContext(PreviewGroupContext);

// ========================== Preview ===========================
const canPreview = !!preview;
const canPreview = !!preview && (!groupContext || groupContext.canPreview);

const {
src: previewSrc,
Expand Down Expand Up @@ -243,7 +245,7 @@ const ImageInternal: CompoundedComponent<ImageProps> = props => {
onClick={canPreview ? onPreview : onClick}
role={canPreview ? 'button' : otherProps.role}
tabIndex={canPreview && otherProps.tabIndex == null ? 0 : otherProps.tabIndex}
aria-label={canPreview ? otherProps['aria-label'] ?? alt : otherProps['aria-label']}
aria-label={canPreview ? (otherProps['aria-label'] ?? alt) : otherProps['aria-label']}
onKeyDown={onPreviewKeyDown}
style={{
width,
Expand Down
54 changes: 34 additions & 20 deletions src/PreviewGroup.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ const Group: React.FC<PreviewGroupProps> = ({
...restProps
} = preview && typeof preview === 'object' ? preview : ({} as GroupPreviewConfig);

const canPreview = preview !== false && preview !== null;

// ========================== Items ===========================
const [mergedItems, register, fromItems] = usePreviewItems(items);

Expand All @@ -80,6 +82,10 @@ const Group: React.FC<PreviewGroupProps> = ({

const onPreviewFromImage = React.useCallback<OnGroupPreview>(
(id, imageSrc, mouseX, mouseY) => {
if (!canPreview) {
return;
}

const index = fromItems
? mergedItems.findIndex(item => item.data.src === imageSrc)
: mergedItems.findIndex(item => item.id === id);
Expand All @@ -91,7 +97,7 @@ const Group: React.FC<PreviewGroupProps> = ({

setKeepOpenIndex(true);
},
[mergedItems, fromItems],
[canPreview, mergedItems, fromItems],
);

// Reset current when reopen
Expand All @@ -105,6 +111,12 @@ const Group: React.FC<PreviewGroupProps> = ({
}
}, [isShowPreview]);

React.useEffect(() => {
if (!canPreview) {
setShowPreview(false);
}
}, [canPreview, setShowPreview]);

// ========================== Events ==========================
const onInternalChange: GroupPreviewConfig['onChange'] = (next, prev) => {
setCurrent(next);
Expand All @@ -119,31 +131,33 @@ const Group: React.FC<PreviewGroupProps> = ({

// ========================= Context ==========================
const previewGroupContext = React.useMemo(
() => ({ register, onPreview: onPreviewFromImage }),
[register, onPreviewFromImage],
() => ({ register, onPreview: onPreviewFromImage, canPreview }),
[register, onPreviewFromImage, canPreview],
);

// ========================== Render ==========================
return (
<PreviewGroupContext.Provider value={previewGroupContext}>
{children}
<Preview
aria-hidden={!isShowPreview}
open={isShowPreview}
prefixCls={previewPrefixCls}
onClose={onPreviewClose}
mousePosition={mousePosition}
imgCommonProps={imgCommonProps}
src={src}
fallback={fallback}
icons={icons}
current={current}
count={mergedItems.length}
onChange={onInternalChange}
{...restProps}
classNames={classNames?.popup}
styles={styles?.popup}
/>
{canPreview && (
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
<Preview
aria-hidden={!isShowPreview}
open={isShowPreview}
prefixCls={previewPrefixCls}
onClose={onPreviewClose}
mousePosition={mousePosition}
imgCommonProps={imgCommonProps}
src={src}
fallback={fallback}
icons={icons}
current={current}
count={mergedItems.length}
onChange={onInternalChange}
{...restProps}
classNames={classNames?.popup}
styles={styles?.popup}
/>
)}
</PreviewGroupContext.Provider>
);
};
Expand Down
1 change: 1 addition & 0 deletions src/context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import type { OnGroupPreview, RegisterImage } from './interface';
export interface PreviewGroupContextProps {
register: RegisterImage;
onPreview: OnGroupPreview;
canPreview: boolean;
}

export const PreviewGroupContext = React.createContext<PreviewGroupContextProps | null>(null);
65 changes: 65 additions & 0 deletions tests/previewGroup.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,71 @@ describe('PreviewGroup', () => {
expect(document.querySelector('.rc-image-preview')).toBeFalsy();
});

it('group preview={false} should disable preview', () => {
const { container } = render(
<Image.PreviewGroup preview={false}>
<Image src="src1" />
</Image.PreviewGroup>,
);

fireEvent.click(container.querySelector('.rc-image'));

expect(document.querySelector('.rc-image-preview')).toBeFalsy();
expect(container.querySelector('.rc-image-cover')).toBeFalsy();
});

it('group preview={null} should disable preview', () => {
const { container } = render(
<Image.PreviewGroup preview={null as unknown as boolean}>
<Image src="src1" />
</Image.PreviewGroup>,
);

fireEvent.click(container.querySelector('.rc-image'));

expect(document.querySelector('.rc-image-preview')).toBeFalsy();
});

it('should not reopen preview after disable and re-enable', () => {
const { container, rerender } = render(
<Image.PreviewGroup>
<Image src="src1" />
</Image.PreviewGroup>,
);

fireEvent.click(container.querySelector('.rc-image'));
act(() => {
jest.runAllTimers();
});
expect(document.querySelector('.rc-image-preview')).toBeTruthy();

rerender(
<Image.PreviewGroup preview={false}>
<Image src="src1" />
</Image.PreviewGroup>,
);
act(() => {
jest.runAllTimers();
});
expect(document.querySelector('.rc-image-preview')).toBeFalsy();

rerender(
<Image.PreviewGroup>
<Image src="src1" />
</Image.PreviewGroup>,
);
act(() => {
jest.runAllTimers();
});
expect(document.querySelector('.rc-image-preview')).toBeFalsy();

fireEvent.click(container.querySelector('.rc-image'));
act(() => {
jest.runAllTimers();
});
expect(document.querySelector('.rc-image-preview')).toBeTruthy();
});

it('Keyboard Enter should open preview from group image', () => {
const { container } = render(
<Image.PreviewGroup>
Expand Down