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

[ModalManager] Lock body scroll when container is inside shadow DOM #33168

Merged
merged 2 commits into from Jun 22, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 33 additions & 0 deletions packages/mui-base/src/ModalUnstyled/ModalManager.test.js
Expand Up @@ -167,6 +167,39 @@ describe('ModalManager', () => {
expect(fixedNode.style.paddingRight).to.equal('');
});

describe('shadow dom', () => {
let shadowContainer;
let container2;

beforeEach(() => {
shadowContainer = document.createElement('div');
const shadowRoot = shadowContainer.attachShadow({ mode: 'open' });
container2 = document.createElement('div');
shadowRoot.appendChild(container2);
});

afterEach(() => {
document.body.removeChild(shadowContainer);
});

it('should scroll body when parent is shadow root', () => {
const modal = {};

container2.style.overflow = 'scroll';

document.body.appendChild(shadowContainer);
modalManager.add(modal, container2);
modalManager.mount(modal, {});

expect(container2.style.overflow).to.equal('scroll');
expect(document.body.style.overflow).to.equal('hidden');
modalManager.remove(modal);

expect(container2.style.overflow).to.equal('scroll');
expect(document.body.style.overflow).to.equal('');
});
});

describe('restore styles', () => {
let container2;

Expand Down
23 changes: 15 additions & 8 deletions packages/mui-base/src/ModalUnstyled/ModalManager.ts
Expand Up @@ -122,14 +122,21 @@ function handleContainer(containerInfo: Container, props: ManagedModalProps) {
});
}

// Improve Gatsby support
// https://css-tricks.com/snippets/css/force-vertical-scrollbar/
const parent = container.parentElement;
const containerWindow = ownerWindow(container);
const scrollContainer =
parent?.nodeName === 'HTML' && containerWindow.getComputedStyle(parent).overflowY === 'scroll'
? parent
: container;
let scrollContainer: HTMLElement;

if (container.parentNode instanceof DocumentFragment) {
scrollContainer = ownerDocument(container).body;
} else {
// Improve Gatsby support
// https://css-tricks.com/snippets/css/force-vertical-scrollbar/
const parent = container.parentElement;
const containerWindow = ownerWindow(container);
scrollContainer =
parent?.nodeName === 'HTML' &&
containerWindow.getComputedStyle(parent).overflowY === 'scroll'
? parent
: container;
}

// Block the scroll even if no scrollbar is visible to account for mobile keyboard
// screensize shrink.
Expand Down
1 change: 1 addition & 0 deletions test/utils/createDOM.js
Expand Up @@ -16,6 +16,7 @@ const whitelist = [
'Node',
'Performance',
'document',
'DocumentFragment',
];
const blacklist = ['sessionStorage', 'localStorage'];

Expand Down