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.

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

Jump to bottom

fix(ui): don't reset scroll lock on hidden modal update #853

Merged
merged 1 commit into from
Aug 1, 2019
Merged

fix(ui): don't reset scroll lock on hidden modal update #853

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
13 changes: 11 additions & 2 deletions ui/src/Components/Modal/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import ReactDOM from "react-dom";
import PropTypes from "prop-types";

import { observer } from "mobx-react";
import { observable } from "mobx";

import { disableBodyScroll, clearAllBodyScrollLocks } from "body-scroll-lock";

Expand All @@ -29,6 +30,7 @@ const Modal = observer(
super(props);
this.modalRef = React.createRef();
this.HotKeysRef = React.createRef();
this.lastIsOpen = observable.box(false);
}

toggleBodyClass = isOpen => {
Expand All @@ -39,16 +41,23 @@ const Modal = observer(
} else {
clearAllBodyScrollLocks();
}
this.lastIsOpen.set(isOpen);
};

componentDidMount() {
const { isOpen } = this.props;
this.toggleBodyClass(isOpen);
if (isOpen) {
this.toggleBodyClass(isOpen);
}
}

componentDidUpdate() {
const { isOpen } = this.props;
this.toggleBodyClass(isOpen);
// we shouldn't update if modal is hidden and was hidden previously
// which can happen when the button gets re-rendered
if (this.lastIsOpen.get() === true || isOpen === true) {
this.toggleBodyClass(isOpen);
}
}

componentWillUnmount() {
Expand Down
24 changes: 19 additions & 5 deletions ui/src/Components/Modal/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,31 @@ describe("<Modal />", () => {
expect(document.body.className.split(" ")).toContain("modal-open");
});

it("'modal-open' class is removed from body node after modal is hidden", () => {
MountedModal(false);
expect(document.body.className.split(" ")).not.toContain("modal-open");
});

it("'modal-open' class is removed from body node after modal is unmounted", () => {
const tree = MountedModal(true);
tree.unmount();
expect(document.body.className.split(" ")).not.toContain("modal-open");
});

it("'modal-open' class is not removed from body when hidden modal is updated", () => {
document.body.classList.toggle("modal-open", true);
const tree = MountedModal(false);
expect(document.body.className.split(" ")).toContain("modal-open");
tree.instance().componentDidUpdate();
expect(document.body.className.split(" ")).toContain("modal-open");
});

it("'modal-open' class is removed from body when visible modal is updated to be hidden", () => {
document.body.classList.toggle("modal-open", true);
let isOpen = true;
const tree = MountedModal(isOpen);
expect(document.body.className.split(" ")).toContain("modal-open");

isOpen = false;
tree.instance().componentDidUpdate();
expect(document.body.className.split(" ")).toContain("modal-open");
});

it("passes extra props down to the MountModal animation component", () => {
const onExited = jest.fn();
const tree = mount(
Expand Down