[Enhancement] Changes in navigation events parameters (#28384)

* Added repro sample

* Added UITests

* Changes in navigation events parameters

* Fix failing UITest

* Fixed test

* Fixed test on iOS/Catalyst

* Renamed NavigationType.PageSwap to NavigationType.Replace

* Removed NavigationType.Initialized

* Added two more samples, using tabs and flyout

* Updated sample

* Create Issue21814TabbedPage.cs

* Updated flyout sample

* Adding more tests

* Added more TabbedPage tests

* More FlyoutPage tests

* Updated test

* Fixed tests

* Use Replace with Tabs and FlyoutItems

* Fixed unit tests

* Updated test

* Fix iOS Flyout tests

* Changes in tests

* Fix test on Android

* Fixed Windows test

* Fixed parameters in NavigatingFromEventArgs

* Updated TabbedPage unit test

* Added more navigation unit tests

* - fix publicapi.txt files

* Update FlyoutPage.cs

* Update FlyoutPage.cs

* Update MultiPage.cs

* - fix publicapi

* More tests

* Fixed device test

* Changes based on PR feedback, simplify FlyoutPage Detail

* More changes to fix a test

* [ci] Update the publicapi

* - remove navigatingfrom

* Updated tests

---------

Co-authored-by: Shane Neuville (HE/HIM) <[email protected]>
Co-authored-by: Rui Marinho <[email protected]>

Author: 3 people

src/Controls/src/Core/FlyoutPage/FlyoutPage.cs

@@ -53,24 +53,44 @@ public Page Detail
 					throw new InvalidOperationException("Detail must not already have a parent.");
 
 				var previousDetail = _detail;
-				// TODO MAUI refine this to fire earlier
-				_detail?.SendNavigatingFrom(new NavigatingFromEventArgs());
 
+				// Get the actual pages for navigation events (unwrap NavigationPages)
+				var destinationPage =
+					value is NavigationPage destinationNavPage ? destinationNavPage.CurrentPage : value;
+				var previousPage = previousDetail is NavigationPage previousNavPage
+					? previousNavPage.CurrentPage
+					: previousDetail;
+
+				// Send NavigatingFrom event to the previous detail (if any)
+				if (previousDetail is not null)
+				{
+					previousDetail.SendNavigatingFrom(new NavigatingFromEventArgs(destinationPage,
+						NavigationType.Replace));
+				}
+
+				// Update the detail property
 				OnPropertyChanging();
-				if (_detail != null)
+				if (_detail is not null)
 					InternalChildren.Remove(_detail);
 				_detail = value;
 				InternalChildren.Add(_detail);
 				OnPropertyChanged();
 
-				if (this.HasAppeared)
+				// Handle Appearing/Disappearing events if the FlyoutPage has appeared
+				if (HasAppeared)
 				{
 					previousDetail?.SendDisappearing();
 					_detail?.SendAppearing();
 				}
 
-				previousDetail?.SendNavigatedFrom(new NavigatedFromEventArgs(_detail, NavigationType.PageSwap));
-				_detail?.SendNavigatedTo(new NavigatedToEventArgs(previousDetail));
+				// Send NavigatedFrom and NavigatedTo events
+				if (previousDetail is not null)
+				{
+					previousDetail.SendNavigatedFrom(
+						new NavigatedFromEventArgs(destinationPage, NavigationType.Replace));
+				}
+
+				_detail.SendNavigatedTo(new NavigatedToEventArgs(previousPage, NavigationType.Replace));
 			}
 		}
 
@@ -108,8 +128,9 @@ public Page Flyout
 
 				// TODO MAUI refine this to fire earlier
 				var previousFlyout = _flyout;
+				
 				// TODO MAUI refine this to fire earlier
-				_flyout?.SendNavigatingFrom(new NavigatingFromEventArgs());
+				previousFlyout?.SendNavigatingFrom(new NavigatingFromEventArgs(value, NavigationType.Replace));
 
 				OnPropertyChanging();
 				if (_flyout != null)
@@ -123,9 +144,9 @@ public Page Flyout
 					previousFlyout?.SendDisappearing();
 					_flyout?.SendAppearing();
 				}
-
-				previousFlyout?.SendNavigatedFrom(new NavigatedFromEventArgs(_flyout, NavigationType.PageSwap));
-				_flyout?.SendNavigatedTo(new NavigatedToEventArgs(previousFlyout));
+				
+				previousFlyout?.SendNavigatedFrom(new NavigatedFromEventArgs(_flyout, NavigationType.Replace));
+				_flyout?.SendNavigatedTo(new NavigatedToEventArgs(previousFlyout, NavigationType.Replace));
 			}
 		}
 

src/Controls/src/Core/MultiPage.cs

@@ -83,10 +83,15 @@ public T CurrentPage
 
 				var previousPage = _current;
 				OnPropertyChanging();
-
+ 				
 				// TODO: MAUI refine this to fire earlier
-				_current?.SendNavigatingFrom(new NavigatingFromEventArgs());
-
+				
+				// Send NavigatingFrom to the previous page or to the new page if no previous page exists
+				if (_current is not null)
+				{
+					_current.SendNavigatingFrom(new NavigatingFromEventArgs(value, NavigationType.Replace));
+				}
+				
 				_current = value;
 
 				previousPage?.SendDisappearing();
@@ -96,9 +101,10 @@ public T CurrentPage
 
 				if (HasAppeared)
 					_current?.SendAppearing();
-
-				previousPage?.SendNavigatedFrom(new NavigatedFromEventArgs(_current, NavigationType.PageSwap));
-				_current?.SendNavigatedTo(new NavigatedToEventArgs(previousPage));
+				
+				
+				previousPage?.SendNavigatedFrom(new NavigatedFromEventArgs(_current, NavigationType.Replace));
+				_current?.SendNavigatedTo(new NavigatedToEventArgs(previousPage, NavigationType.Replace));
 			}
 		}
 
@@ -377,4 +383,4 @@ void UpdateCurrentPage()
 				CurrentPage = (T)SelectedItem;
 		}
 	}
-}
+}

src/Controls/src/Core/NavigationModel.cs

@@ -113,7 +113,7 @@ public Page PopModal()
 				_navTree[0].Count > 0 &&
 				_navTree[0][0] is not Shell)
 			{
-				previousPage.SendNavigatingFrom(new NavigatingFromEventArgs());
+				previousPage.SendNavigatingFrom(new NavigatingFromEventArgs(CurrentPage, NavigationType.Pop));
 				previousPage.SendDisappearing();
 				CurrentPage.SendAppearing();
 			}
@@ -201,7 +201,7 @@ public void PushModal(Page page)
 				_navTree[0].Count > 0 &&
 				_navTree[0][0] is not Shell)
 			{
-				previousPage.SendNavigatingFrom(new NavigatingFromEventArgs());
+				previousPage.SendNavigatingFrom(new NavigatingFromEventArgs(page, NavigationType.Push));
 				previousPage.SendDisappearing();
 				page.SendAppearing();
 			}

src/Controls/src/Core/NavigationPage/NavigationPage.Legacy.cs

@@ -25,7 +25,7 @@ async Task<Page> PopAsyncInner(
 
 			var page = (Page)InternalChildren.Last();
 			var previousPage = CurrentPage;
-			SendNavigating();
+			SendNavigating(NavigationType.Pop, previousPage);
 			var removedPage = await RemoveAsyncInner(page, animated, fast);
 			SendNavigated(previousPage, NavigationType.Pop);
 			return removedPage;
@@ -150,7 +150,7 @@ async Task PopToRootAsyncInner(bool animated)
 				return;
 
 			var previousPage = CurrentPage;
-			SendNavigating();
+			SendNavigating(NavigationType.PopToRoot, previousPage);
 			FireDisappearing(CurrentPage);
 			FireAppearing((Page)InternalChildren[0]);
 
@@ -183,7 +183,9 @@ async Task PushAsyncInner(Page page, bool animated)
 				return;
 
 			var previousPage = CurrentPage;
-			SendNavigating();
+			var navigationType = DetermineNavigationType();
+			
+			SendNavigating(navigationType, previousPage);
 			FireDisappearing(CurrentPage);
 			FireAppearing(page);
 
@@ -198,9 +200,9 @@ async Task PushAsyncInner(Page page, bool animated)
 
 				if (args.Task != null)
 					await args.Task;
-			}
-
-			SendNavigated(previousPage, NavigationType.Push);
+			} 
+			
+			SendNavigated(previousPage, navigationType);
 			Pushed?.Invoke(this, args);
 		}
 

src/Controls/src/Core/NavigationPage/NavigationPage.cs

@@ -54,6 +54,7 @@ public partial class NavigationPage : Page, IPageContainer<Page>, IBarElement, I
 
 		INavigationPageController NavigationPageController => this;
 
+	
 		partial void Init();
 
 #if WINDOWS || ANDROID || TIZEN
@@ -63,6 +64,7 @@ public partial class NavigationPage : Page, IPageContainer<Page>, IBarElement, I
 #endif
 
 		bool _setForMaui;
+			
 		/// <include file="../../docs/Microsoft.Maui.Controls/NavigationPage.xml" path="//Member[@MemberName='.ctor'][1]/Docs/*" />
 		public NavigationPage() : this(UseMauiHandler)
 		{
@@ -112,6 +114,8 @@ public Color BarTextColor
 
 		internal Task CurrentNavigationTask { get; set; }
 
+		internal NavigationType NavigationType { get; set; }
+
 		/// <include file="../../docs/Microsoft.Maui.Controls/NavigationPage.xml" path="//Member[@MemberName='Peek']/Docs/*" />
 		[EditorBrowsable(EditorBrowsableState.Never)]
 		public Page Peek(int depth)
@@ -377,12 +381,12 @@ protected override bool OnBackButtonPressed()
 		void SendNavigated(Page previousPage, NavigationType navigationType)
 		{
 			previousPage?.SendNavigatedFrom(new NavigatedFromEventArgs(CurrentPage, navigationType));
-			CurrentPage.SendNavigatedTo(new NavigatedToEventArgs(previousPage));
+			CurrentPage.SendNavigatedTo(new NavigatedToEventArgs(previousPage, navigationType));
 		}
 
-		void SendNavigating(Page navigatingFrom = null)
+		void SendNavigating(NavigationType navigationType, Page navigatingFrom = null)
 		{
-			(navigatingFrom ?? CurrentPage)?.SendNavigatingFrom(new NavigatingFromEventArgs());
+			(navigatingFrom ?? CurrentPage)?.SendNavigatingFrom(new NavigatingFromEventArgs(CurrentPage, navigationType));
 		}
 
 
@@ -691,16 +695,17 @@ private protected override void OnHandlerChangedCore()
 				var visiblePage = Navigation.NavigationStack[NavigationStack.Count - 1];
 				RootPage = navStack[0];
 				CurrentPage = visiblePage;
-
+				
+				var navigationType = DetermineNavigationType();
+				
 				SendHandlerUpdateAsync(false, null,
 				() =>
 				{
 					FireAppearing(CurrentPage);
 				},
 				() =>
 				{
-					// TODO this is the wrong navigation type
-					SendNavigated(null, NavigationType.Initialize);
+					SendNavigated(null, navigationType);
 				})
 				.FireAndForget(Handler);
 			}
@@ -712,7 +717,21 @@ private protected override void OnHandlerChangedCore()
 				((IStackNavigation)this).NavigationFinished(this.NavigationStack);
 			}
 		}
+		
+		NavigationType DetermineNavigationType()
+		{
+			var parentPages = this.GetParentPages();
 
+			bool hasTabOrFlyout = parentPages.Any(page => page is FlyoutPage or TabbedPage);
+    
+			if (hasTabOrFlyout)
+			{
+				return NavigationType.Replace;
+			}
+
+			return NavigationType.Push;
+		}
+		
 		// Once we get all platforms over to the new APIs
 		// we can just delete all the code inside NavigationPage.cs that fires "requested" events
 		class MauiNavigationImpl : NavigationProxy
@@ -750,6 +769,7 @@ protected override void OnInsertPageBefore(Page page, Page before)
 				Owner.SendHandlerUpdateAsync(false,
 					() =>
 					{
+						Owner.NavigationType = NavigationType.Insert;
 						int index = Owner.InternalChildren.IndexOf(before);
 						Owner.InternalChildren.Insert(index, page);
 
@@ -783,6 +803,7 @@ protected async override Task<Page> OnPopAsync(bool animated)
 				await Owner.SendHandlerUpdateAsync(animated,
 					() =>
 					{
+						Owner.NavigationType = NavigationType.Pop;
 						Owner.CurrentPage = newCurrentPage;
 						Owner.RemoveFromInnerChildren(currentPage);
 						if (currentPage.TitleView != null)
@@ -792,7 +813,7 @@ await Owner.SendHandlerUpdateAsync(animated,
 					},
 					() =>
 					{
-						Owner.SendNavigating(currentPage);
+						Owner.SendNavigating(NavigationType.Pop, currentPage);
 						Owner.FireDisappearing(currentPage);
 						Owner.FireAppearing(newCurrentPage);
 					},
@@ -817,6 +838,7 @@ protected override Task OnPopToRootAsync(bool animated)
 				return Owner.SendHandlerUpdateAsync(animated,
 					() =>
 					{
+						Owner.NavigationType = NavigationType.PopToRoot;
 						var lastIndex = NavigationStack.Count - 1;
 						while (lastIndex > 0)
 						{
@@ -829,7 +851,7 @@ protected override Task OnPopToRootAsync(bool animated)
 					},
 					() =>
 					{
-						Owner.SendNavigating(previousPage);
+						Owner.SendNavigating(NavigationType.PopToRoot, previousPage);
 						Owner.FireDisappearing(previousPage);
 						Owner.FireAppearing(newPage);
 					},
@@ -845,22 +867,24 @@ protected override Task OnPushAsync(Page root, bool animated)
 				if (Owner.InternalChildren.Contains(root))
 					return Task.CompletedTask;
 
+				var navigationType = Owner.DetermineNavigationType();
 				var previousPage = Owner.CurrentPage;
 
 				return Owner.SendHandlerUpdateAsync(animated,
 					() =>
 					{
+						Owner.NavigationType = navigationType;
 						Owner.PushPage(root);
 					},
 					() =>
 					{
-						Owner.SendNavigating(previousPage);
+						Owner.SendNavigating(navigationType, previousPage);
 						Owner.FireDisappearing(previousPage);
 						Owner.FireAppearing(root);
 					},
 					() =>
 					{
-						Owner.SendNavigated(previousPage, NavigationType.Push);
+						Owner.SendNavigated(previousPage, navigationType);
 						Owner?.Pushed?.Invoke(Owner, new NavigationEventArgs(root));
 					});
 			}
@@ -886,6 +910,7 @@ protected override void OnRemovePage(Page page)
 				Owner.SendHandlerUpdateAsync(false,
 					() =>
 					{
+						Owner.NavigationType = NavigationType.Remove;
 						Owner.RemoveFromInnerChildren(page);
 
 						if (Owner.RootPage == page)

src/Controls/src/Core/Page/NavigatedFromEventArgs.cs

@@ -1,30 +1,18 @@
 #nullable disable
 using System;
-using Microsoft.Maui.Controls.Internals;
 
 namespace Microsoft.Maui.Controls
 {
-	internal enum NavigationType
-	{
-		Push,
-		Pop,
-		PopToRoot,
-		Insert,
-		Remove,
-		PageSwap,
-		Initialize
-	}
-
 	public sealed class NavigatedFromEventArgs : EventArgs
 	{
-		internal NavigationType NavigationType { get; }
+		public NavigationType NavigationType { get; }
 
-		internal Page DestinationPage { get; }
+		public Page DestinationPage { get; }
 
 		internal NavigatedFromEventArgs(Page destinationPage, NavigationType navigationType)
 		{
 			DestinationPage = destinationPage;
 			NavigationType = navigationType;
 		}
 	}
-}
+}

src/Controls/src/Core/Page/NavigatedToEventArgs.cs

@@ -5,11 +5,13 @@ namespace Microsoft.Maui.Controls
 {
 	public sealed class NavigatedToEventArgs : EventArgs
 	{
-		internal NavigatedToEventArgs(Page previousPage)
+		internal NavigatedToEventArgs(Page previousPage, NavigationType navigationType)
 		{
 			PreviousPage = previousPage;
+			NavigationType = navigationType;
 		}
 
-		internal Page PreviousPage { get; }
+		public Page PreviousPage { get; }
+		public NavigationType NavigationType { get; }
 	}
 }