Fix #5439: Fix to prevent the background from shifting when the modal…

[guillermo-escire]

References

• Fixes Background remains scrollable when share modal is open #5439

Description

Fixes an issue where the page background remained scrollable while the AddToAny share modal was open by properly locking and restoring body scroll.

Instructions for Reviewers

This PR fixes the issue where the page background could still be scrolled when the Share modal (AddToAny) was open.

Since AddToAny does not reliably expose lifecycle callbacks for modal open/close events, a DOM-based approach was implemented using a MutationObserver to detect when the modal is present and visible.

List of changes in this PR:

• Added a MutationObserver in SocialService to monitor DOM changes.
• Detects the presence and visibility of the AddToAny modal (.a2a_full).
• Disables background scrolling (overflow: hidden) when the modal is visible.
• Restores scrolling when the modal is closed.
• Added helper method to determine element visibility.
• Included TypeDoc comments for the new methods.

How to test

1. Enable the AddToAny plugin in config.yml.
2. Start the frontend application.
3. Navigate to an item page where the Share button is available.
4. Click the Share button to open the modal.
5. Try scrolling the page in the background:
   • Before fix: background scroll is possible ❌
   • After fix: background scroll is disabled ✅
6. Close the modal:
   • Background scrolling should be restored ✅

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

• My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
• My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
• My PR passes ESLint validation using npm run lint
• My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
• My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
• My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
• My PR aligns with Accessibility guidelines if it makes changes to the user interface.
• My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
• My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
• If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
• If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
• If my PR fixes an issue ticket, I've linked them together.

[github-actions]

Hi @guillermo-escire,
Conflicts have been detected against the base branch.
Please resolve these conflicts as soon as you can. Thanks!

[kanasznagyzoltan]

Our test result: Works as intended. Turned on AddToAny plugin. Page is scrollable at first. After opening the AddToAny modal, the background cannot be scrolled anymore. Closing the modal makes the page scrollable again.

pr_5459.mp4

[guillermo-escire]

Hi @kanasznagyzoltan , Thank you for testing! Glad it works as expected.

[GauravD2t]

Thanks for the fix, @guillermo-escire. I've verified this on the item page:

• Before: Background remained scrollable while sharing.

• After: overflow: hidden is correctly applied to the body via the new SocialService logic.

Restoring scroll works perfectly upon closing. Tests passed on my end as well.

[github-actions]

Hi @guillermo-escire,
Conflicts have been detected against the base branch.
Please resolve these conflicts as soon as you can. Thanks!

[nathanmlf]

Hi @guillermo-escire! Tested it on my end and, as others have attested, besides the merge conflicts, everything is working perfectly. Nice job!