[Enhancement] Changes in navigation events parameters #28384

jsuarezruiz · 2025-03-13T14:23:25Z

Description of Change

Changes in navigation events parameters. This PR apply the following changes:

NavigatedToEventArgs

Make PreviousPage property public.
Added NavigationType property.

NavigatingFromEventArgs

Added DestinationPage property.
Added NavigationType property.

	internal enum NavigationType
	{
		Push,
		Pop,
		PopToRoot,

		Insert, // remove this? 
		Remove, // remove this?

		Replace, // TabbedPage, FlyoutPage, Swapping out the Window.Page

		Initial  // remove this?
	}

Review what fires on TabbedPage and children pages when they are initially set

Issues Fixed

Fixes #21814

jsuarezruiz · 2025-03-13T14:23:51Z

src/Controls/tests/TestCases.Shared.Tests/Tests/Issues/Issue21814.cs

+
+		[Test]
+		[Category(UITestCategories.Navigation)]
+		public void VerifyNavigationEventArgs()


The test running:

Copilot

Pull Request Overview

This PR updates the navigation event argument classes and their corresponding usages by adding a new NavigationType parameter and exposing additional properties.

Updated NavigatedToEventArgs and NavigatingFromEventArgs with a NavigationType parameter and made PreviousPage public.
Propagated the changes across NavigationPage, NavigationPage.Legacy, ModalNavigationManager, FlyoutPage, NavigationModel, and MultiPage to pass appropriate NavigationType values during navigation events.

Reviewed Changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/Controls/src/Core/Page/NavigatingFromEventArgs.cs	Added NavigationType property and updated constructor to accept destination page and navigation type
src/Controls/src/Core/Page/NavigatedToEventArgs.cs	Updated constructor signature to include NavigationType and made PreviousPage public
src/Controls/src/Core/NavigationPage/NavigationPage.cs	Updated calls to SendNavigated and SendNavigating with NavigationType parameters
src/Controls/src/Core/NavigationPage/NavigationPage.Legacy.cs	Updated legacy navigation methods to use the new NavigationType parameters
src/Controls/src/Core/Platform/ModalNavigationManager/ModalNavigationManager.cs	Updated modal navigation lifecycle calls with NavigationType parameters
src/Controls/src/Core/Page/NavigatedFromEventArgs.cs	Changed Visibility of NavigationType enum and related properties from internal to public
src/Controls/src/Core/FlyoutPage/FlyoutPage.cs	Updated flyout navigation event calls with a NavigationType to indicate PageSwap events
src/Controls/src/Core/NavigationModel.cs	Updated modal navigation events with explicit NavigationType parameters
src/Controls/src/Core/MultiPage.cs	Amended current page change events to pass NavigationType for PageSwap events

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

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

PureWeen

We should discuss this more as a team before adding these APIs

jsuarezruiz · 2025-03-14T10:59:02Z

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

 				},
 				() =>
 				{
-					// TODO this is the wrong navigation type


This was passing the wrong navigation type parameter. If we not decide to update the navigation EventArgs with the properties included in this PR, the changes to fix this should be included in another one.

PureWeen · 2025-03-24T13:49:56Z

One area I'm curious about with this one is obsoleting and making sure we aren't ending up with duplicate enums

For example, we already haveNavigationRequestType which is hidden with EditorBrowsable but we might want to obsolete that as well?

rmarinho · 2025-05-14T17:46:20Z

/azp run

azure-pipelines · 2025-05-14T17:46:42Z

Azure Pipelines successfully started running 3 pipeline(s).

mattleibow · 2025-05-30T21:13:56Z

I am adding a do not merge label as @PureWeen said things about discussions. Not sure if that happened, but just in case...

jsuarezruiz · 2025-06-04T13:49:21Z

One area I'm curious about with this one is obsoleting and making sure we aren't ending up with duplicate enums

For example, we already haveNavigationRequestType which is hidden with EditorBrowsable but we might want to obsolete that as well?

In NavigatedFromEventArgs, we have been using the NavigationType enum for defining navigation types. (Reference).

This PR introduces two key improvements:

Making NavigationType public.
Expanding its scope to use it across all the navigation events.

Compared to using NavigationRequestType everywhere (Reference), this approach results in less disruptive changes, maintaining compatibility while refining consistency.

However, both enums are nearly identical, except for certain differences like PageSwap value. Since we are already introducing breaking changes in .NET 10, this is an opportunity to standardize the navigation enum by maintaining a single, unified type for all cases where navigation type needs to be indicated.

jsuarezruiz · 2025-06-04T13:49:52Z

I am adding a do not merge label as @PureWeen said things about discussions. Not sure if that happened, but just in case...

Not yet, we have to review it.

PureWeen · 2025-06-04T14:13:23Z

Discuss naming "PageSwap" and the existence of other types like ShellNavigationSource

jsuarezruiz · 2025-06-17T11:36:23Z

Based on recently added tests, I've identified a platform discrepancy when using FlyoutPage. Specifically:

On Android, the initial NavigationType is set to Push, triggered by: Owner.SendNavigated(previousPage, NavigationType.Push); from the protected override Task OnPushAsync(Page root, bool animated) NavigationPage method.
On iOS, it's set to Replace, using: _detail?.SendNavigatedTo(new NavigatedToEventArgs(previousDetail, NavigationType.Replace)); within the public Page Detail property of Flyout.

This inconsistency leads to different navigation behavior across platforms for the same layout construct, and failing tests.

We must align this behavior so that navigation triggered by changing the FlyoutItem consistently uses NavigationType.Replace, just like it does when switching tabs with TabbedPage. Is that the expected behavior @PureWeen? That would better reflect the nature of layout-level navigation and ensure reliable cross-platform behavior.

PureWeen · 2025-08-01T11:49:20Z

/azp run

azure-pipelines · 2025-08-01T11:49:39Z

Azure Pipelines successfully started running 3 pipeline(s).

PureWeen · 2025-08-01T19:08:57Z

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

-				_detail?.SendNavigatingFrom(new NavigatingFromEventArgs());

+				// Get the actual pages for navigation events (unwrap NavigationPages)
+				var destinationPage =


ederbond · 2025-08-01T23:58:43Z

Finally, can't wait to get it on net 10 GA so I can use Shell without breaking MVVM nor causing memory leak because of extensive usage of Rx.NET 🙏🏼

jsuarezruiz added t/enhancement ☀️ New feature or request area-navigation NavigationPage labels Mar 13, 2025

Copilot AI review requested due to automatic review settings March 13, 2025 14:23

jsuarezruiz requested a review from a team as a code owner March 13, 2025 14:23

jsuarezruiz requested review from StephaneDelcroix and tj-devel709 March 13, 2025 14:23

jsuarezruiz commented Mar 13, 2025

View reviewed changes

Copilot AI reviewed Mar 13, 2025

View reviewed changes

src/Controls/src/Core/Page/NavigatedToEventArgs.cs Show resolved Hide resolved

src/Controls/src/Core/Page/NavigatedFromEventArgs.cs Outdated Show resolved Hide resolved

PureWeen requested changes Mar 13, 2025

View reviewed changes

jsuarezruiz commented Mar 14, 2025

View reviewed changes

PureWeen added the proposal/open label Mar 28, 2025

PureWeen self-assigned this Apr 8, 2025

PureWeen added this to MAUI SDK Ongoing May 7, 2025

PureWeen added this to the .NET 10.0-preview5 milestone May 7, 2025

github-project-automation bot moved this to Todo in MAUI SDK Ongoing May 7, 2025

PureWeen moved this from Todo to Ready To Review in MAUI SDK Ongoing May 20, 2025

rmarinho previously approved these changes May 27, 2025

View reviewed changes

rmarinho dismissed their stale review via 4bb14c5 May 29, 2025 18:52

mattleibow added the do-not-merge Don't merge this PR label May 30, 2025

jsuarezruiz marked this pull request as draft June 5, 2025 10:34

PureWeen modified the milestones: .NET 10.0-preview5, .NET 10.0-preview6 Jun 10, 2025

jsuarezruiz and others added 16 commits July 31, 2025 17:05

Changes in tests

631300c

Fix test on Android

207e075

Fixed Windows test

435fe31

Fixed parameters in NavigatingFromEventArgs

a5f5774

Updated TabbedPage unit test

882f728

Added more navigation unit tests

97e282c

- fix publicapi.txt files

6442596

Update FlyoutPage.cs

5cde60c

Update FlyoutPage.cs

a143401

Update MultiPage.cs

f6f4e70

- fix publicapi

78cd921

More tests

a21aa12

Fixed device test

ed9319a

Changes based on PR feedback, simplify FlyoutPage Detail

97efcee

More changes to fix a test

98bb1cf

[ci] Update the publicapi

4ad8eae

rmarinho force-pushed the fix-21814 branch from 12f02fa to 4ad8eae Compare July 31, 2025 16:12

- remove navigatingfrom

c809393

Updated tests

ddc4874

PureWeen approved these changes Aug 1, 2025

View reviewed changes

github-project-automation bot moved this from Changes Requested to Approved in MAUI SDK Ongoing Aug 1, 2025

PureWeen merged commit 42f1f20 into net10.0 Aug 1, 2025
129 checks passed

PureWeen deleted the fix-21814 branch August 1, 2025 19:06

github-project-automation bot moved this from Approved to Done in MAUI SDK Ongoing Aug 1, 2025

PureWeen reviewed Aug 1, 2025

View reviewed changes

SuthiYuvaraj mentioned this pull request Aug 19, 2025

30985:Fix FlyoutPage Navigating args to not reach down into the NavigationPage #31232

Merged

4 tasks

github-actions bot locked and limited conversation to collaborators Sep 1, 2025

[Enhancement] Changes in navigation events parameters #28384

[Enhancement] Changes in navigation events parameters #28384

Uh oh!

Conversation

jsuarezruiz commented Mar 13, 2025 • edited by PureWeen Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Change

Issues Fixed

Uh oh!

jsuarezruiz Mar 13, 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!

Uh oh!

Uh oh!

PureWeen left a comment

Choose a reason for hiding this comment

Uh oh!

jsuarezruiz Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

PureWeen commented Mar 24, 2025

Uh oh!

rmarinho commented May 14, 2025

Uh oh!

azure-pipelines bot commented May 14, 2025

Uh oh!

mattleibow commented May 30, 2025

Uh oh!

jsuarezruiz commented Jun 4, 2025

Uh oh!

jsuarezruiz commented Jun 4, 2025

Uh oh!

PureWeen commented Jun 4, 2025

Uh oh!

jsuarezruiz commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

PureWeen commented Aug 1, 2025

Uh oh!

azure-pipelines bot commented Aug 1, 2025

Uh oh!

Uh oh!

PureWeen Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

ederbond commented Aug 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

jsuarezruiz commented Mar 13, 2025 •

edited by PureWeen

Loading

jsuarezruiz commented Jun 17, 2025 •

edited

Loading