Skip to content

Commit

Permalink
Bug fix: Overlay components cause page shift if scrollbar is present (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
langermank authored Jan 25, 2023
1 parent fcc58eb commit 49d27b2
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .changeset/seven-dots-breathe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@primer/view-components": patch
---

Bug fix: Adjust the body tag padding-right when an overlay is open to avoid page shift
2 changes: 2 additions & 0 deletions app/components/primer/alpha/modal_dialog.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ export class ModalDialogElement extends HTMLElement {
if (this.open) return
this.setAttribute('open', '')
this.#overlayBackdrop?.classList.remove('Overlay--hidden')
document.body.style.paddingRight = `${window.innerWidth - document.body.clientWidth}px`
document.body.style.overflow = 'hidden'
if (this.#focusAbortController.signal.aborted) {
this.#focusAbortController = new AbortController()
Expand All @@ -91,6 +92,7 @@ export class ModalDialogElement extends HTMLElement {
if (!this.open) return
this.removeAttribute('open')
this.#overlayBackdrop?.classList.add('Overlay--hidden')
document.body.style.paddingRight = '0'
document.body.style.overflow = 'initial'
this.#focusAbortController.abort()
// if #openButton is a child of a menu, we need to focus a suitable child of the menu
Expand Down
15 changes: 15 additions & 0 deletions previews/primer/alpha/dialog_preview.rb
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,21 @@ def with_text_input(title: "Test Dialog", subtitle: nil, button_text: "Show Dial
show_divider: show_divider
})
end

# @label Page with scrollbar and dialog
#
# @param title [String] text
# @param subtitle [String] text
# @param button_text [String] text
# @param show_divider [Boolean] toggle
def body_has_scrollbar_overflow(title: "Test Dialog", subtitle: nil, button_text: "Show Dialog", show_divider: true)
render_with_template(locals: {
title: title,
subtitle: subtitle,
button_text: button_text,
show_divider: show_divider
})
end
end
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<div>
<p>Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur? Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur? Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?</p>
<%= render(Primer::Alpha::Dialog.new(id: "dialog-one", title: title, subtitle: subtitle, visually_hide_title: false)) do |d| %>
<% d.show_button { button_text } %>
<% d.body do %>
<p>Dialog</p>
<% end %>
<% end %>
</div>

0 comments on commit 49d27b2

Please sign in to comment.