[release/10.0.1xx-rc2] Implement SafeAreaEdges property and per-edge safe area control for Android #31798

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

Merged

rmarinho merged 73 commits into release/10.0.1xx-rc2 from backport/pr-31022-to-release/10.0.1xx-rc2

Sep 27, 2025

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

-Original file line number
+Diff line change
@@ Expand Up @@
     			var appBar = _root.FindViewById<AppBarLayout>(Resource.Id.shellcontent_appbar);
-    			ViewCompat.SetOnApplyWindowInsetsListener(appBar, new ShellSectionRenderer.WindowsListener());
+    			GlobalWindowInsetListenerExtensions.TrySetGlobalWindowInsetListener(_root, this.Context);
     			appBar.AddView(_toolbar);
     			_viewhandler = _page.ToHandler(shellContentMauiContext);
@@ Expand Down @@

...rols/src/Core/Compatibility/Handlers/Shell/Android/ShellFlyoutTemplatedContentRenderer.cs

-Original file line number
+Diff line change
@@ Expand Up @@
     		protected IShellContext ShellContext => _shellContext;
     		protected AView FooterView => _footerView?.PlatformView;
     		protected AView View => _rootView;
+    		WindowsListener _windowsListener;
     		public ShellFlyoutTemplatedContentRenderer(IShellContext shellContext)
@@ Expand Down Expand Up @@
     		// - Do not extend; add new logic to the forthcoming implementation instead.
     		internal class WindowsListener : Java.Lang.Object, IOnApplyWindowInsetsListener
     		{
+    			private WeakReference<ImageView> _bgImageRef;
+    			private WeakReference<AView> _flyoutViewRef;
+    			private WeakReference<AView> _footerViewRef;
+    			public AView FlyoutView
+    			{
+    				get
+    				{
+    					if (_flyoutViewRef != null && _flyoutViewRef.TryGetTarget(out var flyoutView))
+    						return flyoutView;
+    					return null;
+    				}
+                    set
+                    {
+    					_flyoutViewRef = new WeakReference<AView>(value);
+                    }
+    			}
+    			public AView FooterView
+    			{
+    				get
+    				{
+    					if (_footerViewRef != null && _footerViewRef.TryGetTarget(out var footerView))
+    						return footerView;
+    					return null;
+    				}
+                    set
+                    {
+    					_footerViewRef = new WeakReference<AView>(value);
+                    }
+    			}
+    			public WindowsListener(ImageView bgImage)
+    			{
+    				_bgImageRef = new WeakReference<ImageView>(bgImage);
+    			}
     			public WindowInsetsCompat OnApplyWindowInsets(AView v, WindowInsetsCompat insets)
     			{
     				if (insets == null || v == null)
     					return insets;
     				// The flyout overlaps the status bar so we don't really care about insetting it
+    				var systemBars = insets.GetInsets(WindowInsetsCompat.Type.SystemBars());
     				var displayCutout = insets.GetInsets(WindowInsetsCompat.Type.DisplayCutout());
+    				var topInset = Math.Max(systemBars?.Top ?? 0, displayCutout?.Top ?? 0);
+    				var bottomInset = Math.Max(systemBars?.Bottom ?? 0, displayCutout?.Bottom ?? 0);
+    				var appbarLayout = v.FindDescendantView<AppBarLayout>((v) => true);
+    				int flyoutViewBottomInset = 0;
+    				if (FooterView is not null)
+    				{
+    					v.SetPadding(0, 0, 0, bottomInset);
+    					flyoutViewBottomInset = 0;
+    				}
+                    else
+                    {
+    					flyoutViewBottomInset = bottomInset;
+    					v.SetPadding(0, 0, 0, 0);
+                    }
+    				if (appbarLayout.MeasuredHeight > 0)
+    				{
+    					FlyoutView?.SetPadding(0, 0, 0, flyoutViewBottomInset);
+    					appbarLayout?.SetPadding(0, topInset, 0, 0);
+    				}
+    				else
+    				{
+    					FlyoutView?.SetPadding(0, topInset, 0, flyoutViewBottomInset);
+    					appbarLayout?.SetPadding(0, 0, 0, 0);
+                    }
-    				v.SetPadding(0, displayCutout?.Top ?? 0, 0, 0);
+    				if (_bgImageRef != null && _bgImageRef.TryGetTarget(out var bgImage) && bgImage != null)
+    				{
+    					bgImage.SetPadding(0, topInset, 0, bottomInset);
+    				}
     				return WindowInsetsCompat.Consumed;
     			}
@@ Expand All / @@ -107,7 +177,6 @@ protected virtual void LoadView(IShellContext shellContext) @@
     			var coordinator = (ViewGroup)layoutInflator.Inflate(Controls.Resource.Layout.flyoutcontent, null);
     			_appBar = coordinator.FindViewById<AppBarLayout>(Controls.Resource.Id.flyoutcontent_appbar);
-    			ViewCompat.SetOnApplyWindowInsetsListener(_appBar, new WindowsListener());
     			(_appBar.LayoutParameters as CoordinatorLayout.LayoutParams)
     				.Behavior = new AppBarLayout.Behavior();
@@ Expand All / @@ -132,6 +201,9 @@ protected virtual void LoadView(IShellContext shellContext) @@
     				LayoutParameters = new LP(coordinator.LayoutParameters)
     			};
+    			_windowsListener = new WindowsListener(_bgImage);
+    			ViewCompat.SetOnApplyWindowInsetsListener(coordinator, _windowsListener);
     			UpdateFlyoutHeaderBehavior();
     			_shellContext.Shell.PropertyChanged += OnShellPropertyChanged;
@@ Expand Down Expand Up / @@ -226,6 +298,7 @@ protected virtual void UpdateFlyoutContent() @@
     			}
     			_flyoutContentView = CreateFlyoutContent(_rootView);
+    			_windowsListener.FlyoutView = _flyoutContentView;
     			if (_flyoutContentView == null)
     				return;
@@ Expand Down Expand Up / @@ -341,6 +414,7 @@ protected virtual void UpdateFlyoutFooter() @@
     				var oldFooterView = _footerView;
     				_rootView.RemoveView(_footerView);
     				_footerView = null;
+    				_windowsListener.FooterView = null;
     				oldFooterView.View = null;
     			}
@@ Expand All / @@ -357,6 +431,8 @@ protected virtual void UpdateFlyoutFooter() @@
     				MatchWidth = true
     			};
+    			_windowsListener.FooterView = _footerView;
     			var footerViewLP = new CoordinatorLayout.LayoutParams(0, 0)
     			{
     				Gravity = (int)(GravityFlags.Bottom | GravityFlags.End)
@@ Expand Down @@

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

-Original file line number
+Diff line change
@@ Expand Up @@
     			var context = Context;
     			var root = PlatformInterop.CreateShellCoordinatorLayout(context);
     			var appbar = PlatformInterop.CreateShellAppBar(context, Resource.Attribute.appBarLayoutStyle, root);
-    			ViewCompat.SetOnApplyWindowInsetsListener(appbar, new WindowsListener());
+    			GlobalWindowInsetListenerExtensions.TrySetGlobalWindowInsetListener(root, this.Context);
     			int actionBarHeight = context.GetActionBarHeight();
     			var shellToolbar = new Toolbar(shellSection);
@@ Expand Down Expand Up @@
     			return _rootView = root;
     		}
-    		// Temporary workaround:
-    		// Android 15 / API 36 removed the prior opt‑out path for edge‑to‑edge
-    		// (legacy "edge to edge ignore" + decor fitting). This placeholder exists
-    		// so we can keep apps from regressing (content accidentally covered by
-    		// system bars) until a proper, unified edge‑to‑edge + system bar inset
-    		// configuration API is implemented in MAUI.
-    		//
-    		// NOTE:
-    		// - Keep this minimal.
-    		// - Will be replaced by the planned comprehensive window insets solution.
-    		// - Do not extend; add new logic to the forthcoming implementation instead.
-    		internal class WindowsListener : Java.Lang.Object, IOnApplyWindowInsetsListener
-    		{
-    			public WindowInsetsCompat OnApplyWindowInsets(AView v, WindowInsetsCompat insets)
-    			{
-    				if (insets == null || v == null)
-    					return insets;
-    				var systemBars = insets.GetInsets(WindowInsetsCompat.Type.SystemBars());
-    				var displayCutout = insets.GetInsets(WindowInsetsCompat.Type.DisplayCutout());
-    				var topInset = Math.Max(systemBars?.Top ?? 0, displayCutout?.Top ?? 0);
-    				v.SetPadding(0, topInset, 0, 0);
-    				return WindowInsetsCompat.Consumed;
-    			}
-    		}
     		void OnShellContentPropertyChanged(object sender, System.ComponentModel.PropertyChangedEventArgs e)
     		{
     			if (e.PropertyName == ShellContent.TitleProperty.PropertyName && sender is ShellContent shellContent)
@@ Expand Down @@

src/Controls/src/Core/ContentPage/ContentPage.cs

-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,7 @@ @@
     using Microsoft.Maui.Graphics;
     using Microsoft.Maui.HotReload;
     using Microsoft.Maui.Layouts;
+    using Microsoft.Maui.Devices;
     namespace Microsoft.Maui.Controls
     {
@@ Expand Down Expand Up @@
     				return SafeAreaEdges.GetEdge(edge);
     			}
+    			#if IOS || MACCATALYST
     			// Developer hasn't set SafeAreaEdges, fall back to legacy IgnoreSafeArea behavior
     			var ignoreSafeArea = ((ISafeAreaView)this).IgnoreSafeArea;
     			if (ignoreSafeArea)
@@ Expand All @@
     			{
     				return SafeAreaRegions.Container; // If legacy says "don't ignore", return Container
     			}
+    			#else
+    			// By default on android it was never edge to edge so we set this to container by default
+    			return SafeAreaRegions.Container;
+    			#endif
     		}
     		SafeAreaEdges ISafeAreaElement.SafeAreaEdgesDefaultValueCreator()
@@ Expand Down @@

src/Controls/src/Core/Platform/ModalNavigationManager/ModalNavigationManager.Android.cs

-Original file line number
+Diff line change
@@ Expand Up / @@ -206,6 +206,7 @@ internal class ModalFragment : DialogFragment @@
     			Page _modal;
     			IMauiContext _mauiWindowContext;
     			NavigationRootManager? _navigationRootManager;
+    			GlobalWindowInsetListener? _modalInsetListener;
     			static readonly ColorDrawable TransparentColorDrawable = new(AColor.Transparent);
     			bool _pendingAnimation = true;
@@ Expand Down Expand Up @@
     				var rootView = _navigationRootManager?.RootView ??
     					throw new InvalidOperationException("Root view not initialized");
-    				ViewCompat.SetOnApplyWindowInsetsListener(rootView, new WindowHandler.WindowsListener());
+    				var context = rootView.Context ?? inflater.Context;
+    				if (context is not null)
+    				{
+    					// Modal pages get their own separate GlobalWindowInsetListener instance
+    					// This prevents cross-contamination with the main window's inset tracking
+    					_modalInsetListener = new GlobalWindowInsetListener();
+    					ViewCompat.SetOnApplyWindowInsetsListener(rootView, _modalInsetListener);
+    				}
     				if (IsAnimated)
     				{
@@ Expand Down Expand Up / @@ -368,6 +376,20 @@ public override void OnDismiss(IDialogInterface dialog) @@
     					_modal.Toolbar.Handler = null;
     				}
+    				// Clean up the modal's separate GlobalWindowInsetListener
+    				if (_modalInsetListener is not null)
+    				{
+    					_modalInsetListener.ResetAllViews();
+    					_modalInsetListener.Dispose();
+    					_modalInsetListener = null;
+    				}
+    				var rootView = _navigationRootManager?.RootView;
+    				if (rootView is not null)
+    				{
+    					ViewCompat.SetOnApplyWindowInsetsListener(rootView, null);
+    				}
     				_modal.Handler = null;
     				_modal = null!;
     				_mauiWindowContext = null!;
@@ Expand Down @@

src/Controls/src/Core/SafeAreaElement.cs

-Original file line number
+Diff line change
@@ -1,6 +1,9 @@
     using System;
     using System.ComponentModel;
     using Microsoft.Maui;
+    #if ANDROID
+    using Microsoft.Maui.Platform;
+    #endif
     namespace Microsoft.Maui.Controls
     {
@@ Expand All / @@ -10,17 +13,8 @@ internal static class SafeAreaElement @@
     		/// The backing store for the <see cref="ISafeAreaElement.SafeAreaEdges" /> bindable property.
     		/// </summary>
     		public static readonly BindableProperty SafeAreaEdgesProperty =
-    			BindableProperty.Create("SafeAreaEdges", typeof(SafeAreaEdges), typeof(ISafeAreaElement), SafeAreaEdges.Default,
-    									propertyChanged: OnSafeAreaEdgesChanged,
+    			BindableProperty.Create(nameof(ISafeAreaElement.SafeAreaEdges), typeof(SafeAreaEdges), typeof(ISafeAreaElement), SafeAreaEdges.Default,
     									defaultValueCreator: SafeAreaEdgesDefaultValueCreator);
-    		static void OnSafeAreaEdgesChanged(BindableObject bindable, object oldValue, object newValue)
-    		{
-    			// Centralized implementation - invalidate measure to trigger layout recalculation
-    			if (bindable is IView view)
-    			{
-    				view.InvalidateMeasure();
-    			}
-    		}
     		static object SafeAreaEdgesDefaultValueCreator(BindableObject bindable)
     			=> ((ISafeAreaElement)bindable).SafeAreaEdgesDefaultValueCreator();
@@ Expand Down @@

src/Controls/tests/Core.UnitTests/SafeAreaTests.cs

-Original file line number
+Diff line change
@@ Expand Up @@
     			// ContentPage has special logic - defaults to SafeAreaRegions.None (edge-to-edge) on iOS
     			var safeAreaView2 = (ISafeAreaView2)page;
-    			Assert.Equal(SafeAreaRegions.None, safeAreaView2.GetSafeAreaRegionsForEdge(0));
-    			Assert.Equal(SafeAreaRegions.None, safeAreaView2.GetSafeAreaRegionsForEdge(1));
-    			Assert.Equal(SafeAreaRegions.None, safeAreaView2.GetSafeAreaRegionsForEdge(2));
-    			Assert.Equal(SafeAreaRegions.None, safeAreaView2.GetSafeAreaRegionsForEdge(3));
+    			// only iOS defaults to "None" for ContentPage so we are just validating that the default is container
+    			Assert.Equal(SafeAreaRegions.Container, safeAreaView2.GetSafeAreaRegionsForEdge(0));
+    			Assert.Equal(SafeAreaRegions.Container, safeAreaView2.GetSafeAreaRegionsForEdge(1));
+    			Assert.Equal(SafeAreaRegions.Container, safeAreaView2.GetSafeAreaRegionsForEdge(2));
+    			Assert.Equal(SafeAreaRegions.Container, safeAreaView2.GetSafeAreaRegionsForEdge(3));
     		}
     		// Tests based on existing iOS safe area usage patterns
@@ Expand Down @@

...Controls/tests/DeviceTests/Elements/Shell/ShellFlyoutHeaderBehaviorAndContentTestCases.cs

-Original file line number
+Diff line change
@@ Expand Up @@
     			switch (name)
     			{
     				case "ScrollView":
-    					return new ScrollView() { Content = new Label() { Text = "ScrollView" }, Margin = margin, BackgroundColor = Colors.Orange };
+    					return new ScrollView() { SafeAreaEdges = SafeAreaEdges.None, Content = new Label() { Text = "ScrollView" }, Margin = margin, BackgroundColor = Colors.Orange };
     				case "VerticalStackLayout":
-    					return new VerticalStackLayout() { Margin = margin, Children = { new Label() { Text = "VerticalStackLayout" } }, BackgroundColor = Colors.Orange };
+    					return new VerticalStackLayout() { SafeAreaEdges = SafeAreaEdges.None, Margin = margin, Children = { new Label() { Text = "VerticalStackLayout" } }, BackgroundColor = Colors.Orange };
     			}
     			throw new ArgumentException(nameof(name));
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[release/10.0.1xx-rc2] Implement SafeAreaEdges property and per-edge safe area control for Android #31798

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!