Repository navigation
feat(base-modal): add scrollLock prop to control page scroll behavior - #2200
Merged
Merged
Conversation
victorcg88
approved these changes
Nov 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull request template
Motivation and context
BaseModalalways setsoverflow: hiddenonbodyandhtmlwhile it is open. Consumers that keep a modal open while it is visually hidden (e.g. an embedded predictive layer with no content) end up with a page that can't be scrolled. There was no way to opt out.This adds a
scrollLockprop (defaulttrue, so no behaviour change) to control that lock.Type of change
What is the destination branch of this PR?
MainWhat changed
scrollLockprop onBaseModal(Boolean, defaulttrue).true: unchanged behaviour, locks the page scroll while open and restores it on close.false: the modal never touchesoverflowonbody/html.scrollLockisfalse.BaseIdModal/BaseEventsModalforward it via attribute fallthrough (:scroll-lock="false").BaseModal.How has this been tested?
Unit tests in
base-modal.spec.ts: default lock + restore, no lock withscrollLock=false, toggling while open, not restoring overflow it didn't set, restore on unmount while open.src/components/modals: 61 tests pass; eslint and vue-tsc clean.Checklist: