Skip to content

Fix scrollbar compensation for overlay scrollbars #228

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
infeng merged 1 commit into from
Aug 20, 2026
Merged

Fix scrollbar compensation for overlay scrollbars #228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions src/ViewerCore.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,9 +190,11 @@ export default (props: ViewerProps) => {
overflowY: document.body.style.overflowY,
paddingRight: document.body.style.paddingRight,
};
const scrollbarWidth = window.innerWidth - document.documentElement.clientWidth;
document.body.style.overflow = 'hidden';
if (document.body.scrollHeight > document.body.clientHeight) {
document.body.style.paddingRight = '15px';
if (document.body.scrollHeight > document.body.clientHeight && scrollbarWidth > 0) {
const bodyPaddingRight = parseFloat(window.getComputedStyle(document.body).paddingRight) || 0;
document.body.style.paddingRight = `${bodyPaddingRight + scrollbarWidth}px`;
}
return () => {
document.body.style.overflow = originalBodyStyle.overflow;
Expand Down
65 changes: 65 additions & 0 deletions src/__tests__/viewer.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ function $$(className) {
return document.body.querySelectorAll(className);
}

function restoreProperty(target, property, descriptor) {
if (descriptor) {
Object.defineProperty(target, property, descriptor);
} else {
delete target[property];
}
}

interface ViewerTesterProps {
hasContainer?: boolean;
onChangeImages?: () => ViewerProps['images'];
Expand Down Expand Up @@ -587,6 +595,63 @@ describe('Viewer', () => {
document.body.style.paddingRight = '';
});

it('preserves body padding for overlay scrollbars', () => {
const originalPaddingRight = document.body.style.paddingRight;
const originalInnerWidth = Object.getOwnPropertyDescriptor(window, 'innerWidth');
const originalClientWidth = Object.getOwnPropertyDescriptor(document.documentElement, 'clientWidth');
const originalScrollHeight = Object.getOwnPropertyDescriptor(document.body, 'scrollHeight');
const originalClientHeight = Object.getOwnPropertyDescriptor(document.body, 'clientHeight');
Object.defineProperty(window, 'innerWidth', { configurable: true, value: 1000 });
Object.defineProperty(document.documentElement, 'clientWidth', { configurable: true, value: 1000 });
Object.defineProperty(document.body, 'scrollHeight', { configurable: true, value: 1000 });
Object.defineProperty(document.body, 'clientHeight', { configurable: true, value: 500 });
let overlayViewer = null;

try {
document.body.style.paddingRight = '7px';
overlayViewer = mount(<Viewer visible={true} images={[{ src: img }]} />);

expect(document.body.style.paddingRight).toBe('7px');
} finally {
if (overlayViewer) {
overlayViewer.unmount();
}
document.body.style.paddingRight = originalPaddingRight;
restoreProperty(window, 'innerWidth', originalInnerWidth);
restoreProperty(document.documentElement, 'clientWidth', originalClientWidth);
restoreProperty(document.body, 'scrollHeight', originalScrollHeight);
restoreProperty(document.body, 'clientHeight', originalClientHeight);
}
});

it('adds the measured scrollbar width to existing body padding', () => {
const originalInnerWidth = Object.getOwnPropertyDescriptor(window, 'innerWidth');
const originalClientWidth = Object.getOwnPropertyDescriptor(document.documentElement, 'clientWidth');
const originalScrollHeight = Object.getOwnPropertyDescriptor(document.body, 'scrollHeight');
const originalClientHeight = Object.getOwnPropertyDescriptor(document.body, 'clientHeight');
Object.defineProperty(window, 'innerWidth', { configurable: true, value: 1000 });
Object.defineProperty(document.documentElement, 'clientWidth', { configurable: true, value: 980 });
Object.defineProperty(document.body, 'scrollHeight', { configurable: true, value: 1000 });
Object.defineProperty(document.body, 'clientHeight', { configurable: true, value: 500 });
let scrollbarViewer = null;

try {
document.body.style.paddingRight = '7px';
scrollbarViewer = mount(<Viewer visible={true} images={[{ src: img }]} />);

expect(document.body.style.paddingRight).toBe('27px');
} finally {
if (scrollbarViewer) {
scrollbarViewer.unmount();
}
document.body.style.paddingRight = '';
restoreProperty(window, 'innerWidth', originalInnerWidth);
restoreProperty(document.documentElement, 'clientWidth', originalClientWidth);
restoreProperty(document.body, 'scrollHeight', originalScrollHeight);
restoreProperty(document.body, 'clientHeight', originalClientHeight);
}
});

it('reset image', () => {
viewerHelper.new();
viewerHelper.open();
Expand Down