-
Notifications
You must be signed in to change notification settings - Fork 13.4k
fix(content): automatically recalculate offset when header/footer changes #30862
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.
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
base: main
Are you sure you want to change the base?
fix(content): automatically recalculate offset when header/footer changes #30862
Conversation
…nges Previously, ion-content only calculated layout offsets on initialization or window resize. This caused content to be covered or obscured if a header or footer's dimensions changed dynamically (e.g. expanding a searchbar) or if they were added conditionally to the DOM. This implementation adds a ResizeObserver to watch sibling headers/footers for size changes and a MutationObserver to detect when they are added, triggering an automatic recalculation of the --offset-top and --offset-bottom CSS variables. Fixes ionic-team#26981
|
@HappyKnuckles is attempting to deploy a commit to the Ionic Team on Vercel. A member of the Team first needs to authorize it. |
ShaneK
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your PR! This is looking really good! Aside from the broken tests, this is what I would like to see changed
|
|
||
| for (const mutation of mutations) { | ||
| if (mutation.type === 'childList') { | ||
| mutation.addedNodes.forEach((node: any) => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can just use HTMLElement for this? Shouldn't need to use any, preferably
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I typed it as Node and checked for instanceOf HtmlElement in the loop.
| } | ||
| }); | ||
|
|
||
| mutation.removedNodes.forEach((node: any) => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can just use HTMLElement for this? Shouldn't need to use any, preferably
…afety for MutationObserver
Issue number: resolves #26981
What is the current behavior?
Currently, ion-content calculates its layout offsets (--offset-top/bottom) only on initialization or window resize.
If a developer dynamically changes the height of a header or footer (e.g., expanding a searchbar, wrapping text) or adds a toolbar conditionally to the DOM (e.g., via *ngIf), the ion-content does not adjust. This results in content being obscured behind the header/footer.
What is the new behavior?
This PR adds a ResizeObserver and MutationObserver to ion-content to automatically handle dynamic layout changes.
ResizeObserver watches sibling and elements and triggers a recalculation of --offset-top and --offset-bottom whenever their dimensions change.
MutationObserver watches the parent element to detect when or elements are added to or removed from the DOM.
Removes the need for developers to manually listen for standard dynamic layout changes.
Does this introduce a breaking change?
Other information
I have added a new E2E test suite in core/src/components/content/test/auto-offset which covers:
Visual Regression: Ensures no regressions on initial load.
Functional Header: Expands a header dynamically and asserts that content --offset-top update correctly.
Functional Footer: Expands a footer dynamically and asserts that content --offset-bottom update correctly.
Visual Confirmation: Snapshots verify that the content is physically pushed down/up when toolbars expand.
Before:

After:
