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

Prevents body scroll when Dialog is open #3547

Merged
merged 6 commits into from
Jul 26, 2023
Merged

Prevents body scroll when Dialog is open #3547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
be6e70a
prevents body scroll when the dialog is open
mperrotti Jul 21, 2023
2ef3abf
Create tidy-melons-type.md
mperrotti Jul 21, 2023
fa3d244
updates changset
mperrotti Jul 21, 2023
1ca7fc6
keeps track of body overflow style to re-set it on unmount
mperrotti Jul 25, 2023
6b9541f
Merge branch 'main' into mp/dialog-scroll-fix
mperrotti Jul 25, 2023
85b0390
Merge branch 'main' into mp/dialog-scroll-fix
mperrotti Jul 26, 2023
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
7 changes: 7 additions & 0 deletions .changeset/tidy-melons-type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@primer/react": patch
---

Prevents body scroll when Dialog (the newer Dialog) is open

<!-- Changed components: Dialog -->
16 changes: 16 additions & 0 deletions src/Dialog/Dialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,22 @@ const _Dialog = React.forwardRef<HTMLDivElement, React.PropsWithChildren<DialogP
[onClose],
)

React.useEffect(() => {
const bodyOverflowStyle = document.body.style.overflow || ''
// If the body is already set to overflow: hidden, it likely means
// that there is already a modal open. In that case, we should bail
// so we don't re-enable scroll after the second dialog is closed.
if (bodyOverflowStyle === 'hidden') {
return
}

document.body.style.overflow = 'hidden'

return () => {
document.body.style.overflow = bodyOverflowStyle
}
}, [])

const header = (renderHeader ?? DefaultHeader)(defaultedProps)
const body = (renderBody ?? DefaultBody)(defaultedProps)
const footer = (renderFooter ?? DefaultFooter)(defaultedProps)
Expand Down
Loading