Skip to content

feat: add wheel prop to control mouse wheel zoom #521

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
zombieJ merged 7 commits into from
Jul 17, 2026
Merged

feat: add wheel prop to control mouse wheel zoom #521

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
11dbd04
feat: add wheel prop to control mouse wheel zoom
Jul 16, 2026
2f592bf
Merge branch 'master' into feat/add-wheel-prop
EmilyyyLiu Jul 16, 2026
3c4e9ad
feat: add wheel prop to description
Jul 16, 2026
8f125b4
feat: add wheel zoom functionality when wheel prop is true
Jul 17, 2026
4eefec0
ci: run React Doctor with Node 22
zombieJ Jul 17, 2026
04d94fd
ci: pin React Doctor before JSON report regression
zombieJ Jul 17, 2026
c428556
ci: use stable React Doctor release
zombieJ Jul 17, 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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ export default () => (
| closeIcon | React.ReactNode | - | Custom close icon |
| src | string | - | Customize preview src |
| movable | boolean | true | Enable drag |
| wheel | boolean | true | Enable mouse wheel zoom |
| scaleStep | number | 0.5 | The number to which the scale is increased or decreased |
| minScale | number | 1 | Min scale |
| maxScale | number | 50 | Max scale |
Expand Down Expand Up @@ -122,6 +123,7 @@ export default () => (
| --- | --- | --- | --- |
| open | boolean | - | Whether the preview is open or not |
| movable | boolean | true | Enable drag |
| wheel | boolean | true | Enable mouse wheel zoom |
| current | number | - | Current index |
| closeIcon | React.ReactNode | - | Custom close icon |
| scaleStep | number | 0.5 | The number to which the scale is increased or decreased |
Expand Down
5 changes: 5 additions & 0 deletions src/Preview/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,9 @@ export interface InternalPreviewConfig {
minScale?: number;
maxScale?: number;

/** Whether to enable mouse wheel zoom. Default is true. */
wheel?: boolean;

// Display
motionName?: string;
open?: boolean;
Expand Down Expand Up @@ -192,6 +195,7 @@ const Preview: React.FC<PreviewProps> = props => {
styles = {},
mousePosition,
zIndex,
wheel = true,
} = props;

const imgRef = useRef<HTMLImageElement>();
Expand All @@ -215,6 +219,7 @@ const Preview: React.FC<PreviewProps> = props => {
transform,
updateTransform,
dispatchZoomChange,
wheel,
);
const { isTouching, onTouchStart, onTouchMove, onTouchEnd } = useTouchEvent(
imgRef,
Expand Down
3 changes: 2 additions & 1 deletion src/hooks/useMouseEvent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export default function useMouseEvent(
transform: TransformType,
updateTransform: UpdateTransformFunc,
dispatchZoomChange: DispatchZoomChangeFunc,
wheel: boolean = true,
) {
const { rotate, scale, x, y } = transform;

Expand Down Expand Up @@ -83,7 +84,7 @@ export default function useMouseEvent(
};

const onWheel = (event: React.WheelEvent<HTMLImageElement>) => {
if (!open || event.deltaY == 0) return;
if (!open || !wheel || event.deltaY == 0) return;

@gemini-code-assist gemini-code-assist Bot Jul 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Use strict equality === instead of loose equality == for comparing event.deltaY with 0. This is a standard TypeScript best practice to avoid type coercion and ensure type safety.

Suggested change
if (!open || !wheel || event.deltaY == 0) return;
if (!open || !wheel || event.deltaY === 0) return;

// Scale ratio depends on the deltaY size
const scaleRatio = Math.abs(event.deltaY / 100);
// Limit the maximum scale ratio
Expand Down
39 changes: 39 additions & 0 deletions tests/preview.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,45 @@ describe('Preview', () => {
});
});

it('should not zoom with wheel when wheel is false', () => {
const { container } = render(
<Image
src="https://zos.alipayobjects.com/rmsportal/jkjgkEfvpUPVyRjUImniVslZfWPnJuuZ.png"
preview={{
open: true,
wheel: false,
}}
/>,
);

expect(document.querySelector('.rc-image-preview-img')).toHaveStyle({
transform: 'translate3d(0px, 0px, 0) scale3d(1, 1, 1) rotate(0deg)',
});

// Wheel zoom should not work when wheel is false
fireEvent.wheel(document.querySelector('.rc-image-preview-img'), {
deltaY: -50,
});

act(() => {
jest.runAllTimers();
});

// Scale should remain 1
expect(document.querySelector('.rc-image-preview-img')).toHaveStyle({
transform: 'translate3d(0px, 0px, 0) scale3d(1, 1, 1) rotate(0deg)',
});

// But zoom in button should still work
fireEvent.click(document.querySelectorAll('.rc-image-preview-actions-action')[5]);
act(() => {
jest.runAllTimers();
});
expect(document.querySelector('.rc-image-preview-img')).toHaveStyle({
transform: 'translate3d(-256px, -192px, 0) scale3d(1.5, 1.5, 1) rotate(0deg)',
});
});

it('scaleStep = 1', () => {
const { container } = render(
<Image
Expand Down