[Android] - Implement WindowInsetListener for per coordinator layout by NirmalKumarYuvaraj · Pull Request #31898 · dotnet/maui

NirmalKumarYuvaraj · 2025-10-07T12:39:48Z

Note

Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!

Description of Change

This pull request introduces significant improvements to how safe area insets and window inset listeners are managed for Android in the MAUI codebase. The main enhancement is a new registry system for tracking CoordinatorLayout instances and their associated GlobalWindowInsetListeners, allowing for more precise and leak-free management of safe area insets, especially in complex navigation scenarios. Several components now use local listeners instead of a global one, and cleanup logic has been improved to avoid memory leaks.

Safe area and window inset management improvements:

Introduced a static registry in GlobalWindowInsetListener to track CoordinatorLayout instances and their local listeners, enabling views to find the appropriate listener for safe area updates. This includes new helper methods for registering, unregistering, and cleaning up listeners and layouts.
Updated ShellContentFragment and ShellSectionRenderer to use local GlobalWindowInsetListener instances per CoordinatorLayout, including setup and cleanup logic to avoid cross-contamination and memory leaks.
Refactored ViewHandler.Android.cs to use the new registry-based approach for finding the correct GlobalWindowInsetListener for a view, replacing the previous context-based lookup and simplifying the logic for resetting safe areas.
Simplified modal handling by removing the creation and cleanup of separate GlobalWindowInsetListener instances for modals, relying on the new registry system instead.
Updated ContentViewGroup and WindowHandler.Android.cs to use the new registry-based listener lookup and clarified cleanup responsibilities when disconnecting handlers.

These changes collectively make the handling of safe area insets more robust, modular, and less prone to memory leaks or incorrect inset application in complex navigation scenarios.

Fixes #

dotnet-policy-service · 2025-10-07T12:40:15Z

Hey there @@NirmalKumarYuvaraj! Thank you so much for your PR! Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

jsuarezruiz · 2025-10-09T14:06:27Z

/azp run

azure-pipelines · 2025-10-09T14:06:54Z

Azure Pipelines successfully started running 3 pipeline(s).

jsuarezruiz · 2025-10-27T12:36:12Z

src/Core/src/Platform/Android/GlobalWindowInsetListener.cs

+            listener.RegisterCoordinatorLayout(coordinatorLayout);
+
+            // Set up event handlers for attach/detach
+            coordinatorLayout.ViewAttachedToWindow += (sender, e) =>


Lambda captures create strong references and there is no cleanup/unsubscribe mechanism. Could improve it?

@jsuarezruiz , I have updated changes. please let me know if you have any concerns.

Copilot

Pull Request Overview

This PR refactors the Android GlobalWindowInsetListener architecture from a global activity-level pattern to a localized CoordinatorLayout-based approach. Instead of having a single shared listener instance per activity, each CoordinatorLayout now manages its own listener instance which is tracked in a static registry.

Key changes:

Replaced global activity-level listener with local per-CoordinatorLayout listeners tracked in a static registry
Added FindListenerForView() to locate the appropriate listener by traversing view hierarchy
Updated all call sites to use FindListenerForView() instead of Context.GetGlobalWindowInsetListener()

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
GlobalWindowInsetListener.cs	Core refactoring: added static registry, view hierarchy lookup methods, and CoordinatorLayout management
MauiAppCompatActivity.cs	Removed activity-level global listener property and lifecycle management
NavigationRootManager.cs	Changed to create and manage local listener for NavigationRootManager's CoordinatorLayout
SafeAreaExtensions.cs	Updated to use FindListenerForView instead of GetGlobalWindowInsetListener
MauiScrollView.cs	Updated to use FindListenerForView for configuration changes
LayoutViewGroup.cs	Updated to use FindListenerForView for configuration changes
ContentViewGroup.cs	Updated to use FindListenerForView for configuration changes
ViewHandler.Android.cs	Updated MapSafeAreaEdges to use FindListenerForView
WindowHandler.Android.cs	Added cleanup comment for local listener management
ModalNavigationManager.Android.cs	Removed separate modal listener management (now uses registry approach)
ShellSectionRenderer.cs	Added local listener setup and cleanup for Shell sections
ShellContentFragment.cs	Added local listener setup and cleanup for Shell content fragments

Copilot · 2025-10-29T07:55:50Z

src/Controls/src/Core/Compatibility/Handlers/Shell/Android/ShellSectionRenderer.cs

+		GlobalWindowInsetListener _localInsetListener;
+		CoordinatorLayout _managedCoordinatorLayout;


These fields should be marked with ? to indicate nullability since they are assigned after construction and set to null in Destroy(). This should be GlobalWindowInsetListener? _localInsetListener; and CoordinatorLayout? _managedCoordinatorLayout;.

Suggested change

GlobalWindowInsetListener _localInsetListener;

CoordinatorLayout _managedCoordinatorLayout;

GlobalWindowInsetListener? _localInsetListener;

CoordinatorLayout? _managedCoordinatorLayout;

Copilot · 2025-10-29T07:55:50Z

src/Controls/src/Core/Compatibility/Handlers/Shell/Android/ShellContentFragment.cs

+		GlobalWindowInsetListener _localInsetListener;
+		CoordinatorLayout _managedCoordinatorLayout;


These fields should be marked with ? to indicate nullability since they are assigned conditionally in OnCreateView() and set to null in Destroy(). This should be GlobalWindowInsetListener? _localInsetListener; and CoordinatorLayout? _managedCoordinatorLayout;.

Suggested change

GlobalWindowInsetListener _localInsetListener;

CoordinatorLayout _managedCoordinatorLayout;

GlobalWindowInsetListener? _localInsetListener;

CoordinatorLayout? _managedCoordinatorLayout;

Copilot · 2025-10-29T07:55:51Z

src/Core/src/Platform/Android/GlobalWindowInsetListener.cs

+        // No locking needed since this runs on UI thread
+        static readonly List<CoordinatorLayoutEntry> _registeredCoordinatorLayouts = new();


The comment assumes this always runs on the UI thread, but there's no enforcement. Consider adding thread safety or documenting the threading requirements more explicitly, especially since this is a static shared resource that could potentially be accessed from multiple contexts.

PureWeen · 2025-10-29T12:13:36Z

/rebase

jsuarezruiz · 2025-10-29T16:04:20Z

/azp run

azure-pipelines · 2025-10-29T16:04:41Z

Azure Pipelines successfully started running 3 pipeline(s).

jsuarezruiz · 2025-10-29T16:26:35Z

src/Core/src/Platform/Android/GlobalWindowInsetListener.cs

+        /// <summary>
+        /// Checks if a view is contained within the specified layout's hierarchy
+        /// </summary>
+        static bool IsViewContainedIn(AView view, ViewGroup layout)


Can trminate early if another CoordinatorLayout is found in the hierarchy that is not the target layout:

if (parent is CoordinatorLayout && parent != layout) return false;

PureWeen · 2025-10-30T14:26:23Z

Moving this PR over to here
#32278

dotnet-policy-service bot added the community ✨ Community Contribution label Oct 7, 2025

dotnet-policy-service bot added the partner/syncfusion Issues / PR's with Syncfusion collaboration label Oct 7, 2025

jsuarezruiz added the platform/android label Oct 9, 2025

jsuarezruiz suggested changes Oct 27, 2025

View reviewed changes

NirmalKumarYuvaraj force-pushed the SafeAreaFollowUp branch from 981f11f to b52a4e6 Compare October 28, 2025 12:06

NirmalKumarYuvaraj marked this pull request as ready for review October 29, 2025 07:45

Copilot AI review requested due to automatic review settings October 29, 2025 07:45

Copilot AI reviewed Oct 29, 2025

View reviewed changes

PureWeen changed the base branch from net10.0 to main October 29, 2025 12:12

NirmalKumarYuvaraj added 6 commits October 29, 2025 12:14

navigation page

3262e3e

shell and more changes

3f7fbd9

more changes

a6b3507

more changes

ea77478

optimized connect and disconnect logics

f5c17f4

fixed test failures

910f44e

github-actions bot force-pushed the SafeAreaFollowUp branch from 365c14b to 910f44e Compare October 29, 2025 12:14

jsuarezruiz reviewed Oct 29, 2025

View reviewed changes

PureWeen mentioned this pull request Oct 29, 2025

When a FlyoutPage is pushed Modally it doesn't inset the AppBarLayout #32277

Closed

Copilot AI mentioned this pull request Oct 29, 2025

[Android] Refactor WindowInsetListener to per-view registry with MauiWindowInsetListener #32278

Merged

22 tasks

PureWeen closed this Oct 30, 2025

github-actions bot locked and limited conversation to collaborators Nov 30, 2025

		GlobalWindowInsetListener _localInsetListener;
		CoordinatorLayout _managedCoordinatorLayout;

		// No locking needed since this runs on UI thread
		static readonly List<CoordinatorLayoutEntry> _registeredCoordinatorLayouts = new();

Conversation

NirmalKumarYuvaraj commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Change

Uh oh!

dotnet-policy-service bot commented Oct 7, 2025

Uh oh!

jsuarezruiz commented Oct 9, 2025

Uh oh!

azure-pipelines bot commented Oct 9, 2025

Uh oh!

jsuarezruiz Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

NirmalKumarYuvaraj Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

PureWeen commented Oct 29, 2025

Uh oh!

jsuarezruiz commented Oct 29, 2025

Uh oh!

azure-pipelines bot commented Oct 29, 2025

Uh oh!

jsuarezruiz Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

PureWeen commented Oct 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

NirmalKumarYuvaraj commented Oct 7, 2025 •

edited

Loading