Fix offcanvas dispose scroll reset#42711
Draft
Kevinjohn wants to merge 1 commit into
Draft
Conversation
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.
Description
Resets the body scrollbar state when disposing a shown offcanvas with scrolling disabled.
Motivation & Context
Showing an offcanvas with the default
scroll: falsehides body overflow. Ifdispose()is called while the offcanvas is still shown, the instance is removed but the body scroll lock is left behind.Expected: disposing the shown offcanvas clears the scroll lock it created.
Actual: disposing the shown offcanvas leaves
body.style.overflowset tohidden.This mirrors the normal hide cleanup for the dispose path and adds unit coverage for disposing a shown offcanvas.
Related closed reports: #39910 and #36397.
Type of changes
Checklist
Actual screenshots
Before disposing the shown offcanvas, body overflow remains locked:
After the fix, disposing clears the body overflow lock:
Related issues
Related: #39910, #36397.
Checks
git diff --checknpm exec -- eslint --report-unused-disable-directives js/src/offcanvas.js js/tests/unit/offcanvas.spec.jsnpm run js-test-karma