MudDialogProvider: Add CloseOnNavigation to DialogOptions to optionally close dialogs on navigation by aaronleev · Pull Request #12437 · MudBlazor/MudBlazor

aaronleev · 2026-01-13T23:40:25Z

Added CloseOnNavigation property to DialogOptions and implemented the use case for that property.
This use case also required that the IDialogReference now have access to the DialogOptions that were supplied during its creation.

This change fixes an issue with same page navigation where url changes automatically close all dialogs regardless of the navigation destination being somewhere different or the same page simply updating a parameter.

Checklist:

I've read the contribution guidelines
My code follows the style of this project
I've added or updated relevant unit tests.

… closed on navigation.

Note: The DismissAll function is copied over instead of edited, as it is public, to avoid unnecessary api changes.

Add test dialogs being dismissed when navigating when the CloseOnNavigation option is false.

…th a real NavigationManager we need to use BunitNavigationManager instead of MockNavigationManager.

…0397

… null instead of default to true.

…default value (null)

…andling.

…0397

aaronleev · 2026-02-04T15:55:18Z

@danielchalmers

I have add a solution according to your comment.
Where CloseOnNavigation when null will look at the absolute path of where we were and compare it to where we are, if it has changed we close.

We still want to keep CloseOnNavigation as an option as this doesn't address pages that have multiple @page attributes that will get caught by this "smart close" feature.

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 10 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/MudBlazor/Components/Dialog/MudDialogProvider.razor.cs

Copilot · 2026-02-04T17:51:23Z

src/MudBlazor/Services/Dialog/IDialogReference.cs

@@ -67,6 +72,12 @@ public interface IDialogReference
        /// <param name="inst">The new dialog to use.</param>
        void InjectDialog(object inst);

+        /// <summary>
+        /// Replaces the dialog options.
+        /// </summary>
+        /// <param name="options">The new options to use</param>
+        void InjectOptions(DialogOptions options);
+


IDialogReference is a public interface; adding new members (Options, InjectOptions) is a binary breaking change for any external implementation of IDialogReference. If maintaining backwards compatibility is a goal, consider introducing a new derived interface (e.g., IDialogReferenceWithOptions) or providing default interface implementations where possible.

I believe this is an acceptable breaking change, otherwise where does it end.

Copilot · 2026-02-04T17:51:23Z

src/MudBlazor.UnitTests/Components/DialogTests.cs

+            var reference = await service.ShowAsync<DialogOkCancel>();
+            reference.InjectOptions(null);
+


InjectOptions(null) does not compile with the current IDialogReference.InjectOptions(DialogOptions options) signature. Either make InjectOptions accept nullable options, or update these tests to avoid passing null (e.g., verify behavior with CloseOnNavigation = null on a real DialogOptions instance).

This is a test, options are not required on construction of a reference, neither is the RenderFragment or the Dialog instance itself. This is edge case test for a poorly configured IDialogReference.

It will compile it just has a warning on the test case.

(e.g., verify behavior with CloseOnNavigation = null on a real DialogOptions instance). This is verified in other tests in the same file.

Copilot · 2026-02-04T17:51:23Z

src/MudBlazor.UnitTests/Components/DialogTests.cs

+            var reference = await service.ShowAsync<DialogOkCancel>();
+            reference.InjectOptions(null);
+


InjectOptions(null) does not compile with the current IDialogReference.InjectOptions(DialogOptions options) signature. Either make InjectOptions accept nullable options, or update these tests to avoid passing null (e.g., verify behavior with CloseOnNavigation = null on a real DialogOptions instance).

This is a test, options are not required on construction of a reference, neither is the RenderFragment or the Dialog instance itself. This is edge case test for a poorly configured IDialogReference.

It will compile it just has a warning on the test case.

(e.g., verify behavior with CloseOnNavigation = null on a real DialogOptions instance). This is verified in other tests in the same file.

src/MudBlazor/Components/Dialog/MudDialogProvider.razor.cs

Copilot · 2026-02-04T17:51:23Z

src/MudBlazor/Services/Dialog/IDialogReference.cs

+        /// Replaces the dialog options.
+        /// </summary>
+        /// <param name="options">The new options to use</param>
+        void InjectOptions(DialogOptions options);


Nullability is inconsistent: Options is declared as DialogOptions?, but InjectOptions requires a non-null DialogOptions. Either make Options non-nullable (and ensure it's always set at creation) or allow InjectOptions(DialogOptions? options) so callers/tests can represent "no options" consistently.

Suggested change

void InjectOptions(DialogOptions options);

void InjectOptions(DialogOptions? options);

This is consistent with similar functionality in IDialogReference. The options are nullable as they are optional at creation, that doesn't necessarily mean you can later set them to null.

Copilot · 2026-02-04T17:51:24Z

src/MudBlazor/Services/Dialog/DialogReference.cs

        }

+        /// <inheritdoc />
+        public void InjectOptions(DialogOptions options)


DialogReference.InjectOptions cannot set Options back to null because the parameter is non-nullable. This currently conflicts with new unit tests that call InjectOptions(null). Align the signature with the nullable Options property (accept DialogOptions?) or remove the need to ever represent Options == null and adjust tests accordingly.

Suggested change

public void InjectOptions(DialogOptions options)

public void InjectOptions(DialogOptions? options)

This is in reference to a unit test, it is an object reference so unlike a struct nullability is a suggestion. The call to .InjectOptions(null) is for code converge reasons as DialogOptions can be null on the DialogReference.

Copilot · 2026-02-04T17:51:24Z

src/MudBlazor.UnitTests/Components/DialogTests.cs

+            var newUri = $"{uri.GetLeftPart(UriPartial.Path)}?{query}";
+            await comp.InvokeAsync(() => navigationManager.NavigateTo(newUri));
+
+            cont = comp.FindAll("div.mud-dialog-container");


This test expects only 1 dialog to remain after changing only the query string, but the new CloseOnNavigation == null behavior is documented to not close dialogs when only query/fragment changes. After fixing _currentUri initialization, this test will likely fail; update it to assert the intended default behavior (query change keeps dialogs open, path change closes unless CloseOnNavigation == false).

Suggested change

var newUri = $"{uri.GetLeftPart(UriPartial.Path)}?{query}";

await comp.InvokeAsync(() => navigationManager.NavigateTo(newUri));

cont = comp.FindAll("div.mud-dialog-container");

var newUriWithQueryChange = $"{uri.GetLeftPart(UriPartial.Path)}?{query}";

await comp.InvokeAsync(() => navigationManager.NavigateTo(newUriWithQueryChange));

// Changing only the query string should not close dialogs when CloseOnNavigation is null (default)

cont = comp.FindAll("div.mud-dialog-container");

cont.Count.Should().Be(2);

// Changing the path should close dialogs with default CloseOnNavigation, but keep those with CloseOnNavigation = false

var newUriWithPathChange = $"{uri.GetLeftPart(UriPartial.Path)}-other";

await comp.InvokeAsync(() => navigationManager.NavigateTo(newUriWithPathChange));

cont = comp.FindAll("div.mud-dialog-container");

Copilot · 2026-02-04T17:51:24Z

src/MudBlazor.UnitTests/Components/DialogTests.cs

@@ -91,6 +92,39 @@ public async Task Simple()
            result.Canceled.Should().BeFalse();
        }

+        /// <summary>
+        /// Opening and closing dialogs via navigation.
+        /// </summary>
+        [Test]
+        public async Task CloseOnNavigationTest()
+        {
+            var comp = Context.Render<MudDialogProvider>();
+            comp.Markup.Trim().Should().BeEmpty();
+            var dialogService = Context.Services.GetRequiredService<IDialogService>();
+            dialogService.Should().NotBe(null);
+            var navigationManager = Context.Services.GetRequiredService<NavigationManager>();
+            navigationManager.Should().NotBe(null);
+
+            //create 2 instances and dismiss all except for one with CloseOnNavigation = false
+            var closeOnNavigationOptions = new DialogOptions
+            {
+                CloseOnNavigation = false
+            };
+            await comp.InvokeAsync(async () => _ = await dialogService.ShowAsync<DialogOkCancel>("test", options: closeOnNavigationOptions));
+            await comp.InvokeAsync(async () => _ = await dialogService.ShowAsync<DialogOkCancel>());
+            var cont = comp.FindAll("div.mud-dialog-container");
+            cont.Count.Should().Be(2);
+
+            var uri = new Uri(navigationManager.Uri);
+            var query = HttpUtility.ParseQueryString(uri.Query);
+            query["query"] = Guid.NewGuid().ToString();
+            var newUri = $"{uri.GetLeftPart(UriPartial.Path)}?{query}";
+            await comp.InvokeAsync(() => navigationManager.NavigateTo(newUri));


Introducing using System.Web; / HttpUtility.ParseQueryString adds a new dependency that does not appear to be referenced in the test project and may fail to compile on modern .NET targets. Prefer a framework-native approach (e.g., UriBuilder, simple string concat, or Microsoft.AspNetCore.WebUtilities.QueryHelpers) to construct a URI with updated query parameters.

Copilot · 2026-02-04T17:51:24Z

src/MudBlazor.Docs/Pages/Components/Dialog/Examples/DialogSetOptionsExample_Dialog.razor

@@ -7,6 +10,8 @@
            <MudButton OnClick="ToggleCloseButtonAsync">Toggle Close Button</MudButton>
            <MudButton OnClick="ToggleFullWidthAsync">Toggle Full Width</MudButton>
            <MudButton OnClick="ToggleHeaderAsync">Toggle Header</MudButton>
+            <MudCheckBox TriState="true" T="bool?" Value="MudDialog.Options.CloseOnNavigation" ValueChanged="@(async v => await CloseOnNavigationChangedAsync(v))">Close On Navigation</MudCheckBox>
+            <MudButton OnClick="ChangeUrl">Change Url</MudButton>
        </div>
    </DialogContent>
    <DialogActions>
@@ -18,6 +23,13 @@
    [CascadingParameter]
    private IMudDialogInstance MudDialog { get; set; }

+    [SupplyParameterFromQuery(Name = "example")]
+    public int? QueryParameterExample { get; set; }
+
+    protected override void OnParametersSet() {
+        QueryParameterExample ??= 0;
+    }
+
    private void Close() => MudDialog.Close(DialogResult.Ok(true));

    private Task ChangeTitleAsync() => MudDialog.SetTitleAsync($"Current time is: {DateTime.Now}");
@@ -51,4 +63,26 @@

        return MudDialog.SetOptionsAsync(options);
    }
+
+    private void ChangeUrl() {
+        var uri = new Uri(NavigationManager.Uri);
+
+        var query = HttpUtility.ParseQueryString(uri.Query);
+
+        query["example"] = (QueryParameterExample + 1).ToString();
+
+        var newUri = $"{uri.GetLeftPart(UriPartial.Path)}?{query}";
+
+        NavigationManager.NavigateTo(newUri);


@using System.Web / HttpUtility.ParseQueryString introduces a dependency that isn't referenced in the docs project (and is generally avoided in Blazor). Since MudBlazor.Docs already references Microsoft.AspNetCore.WebUtilities, consider using QueryHelpers.AddQueryString (or UriBuilder) to update the query string without relying on System.Web APIs.

danielchalmers · 2026-02-04T22:16:18Z

Sorry about Copilot - Thank you for all your work on this!!

…ly close dialogs on navigation (MudBlazor#12437) Co-authored-by: avalerio <avalerio@tnwops.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Daniel Chalmers <daniel.chalmers@outlook.com>

avalerio and others added 5 commits January 13, 2026 15:26

DialogOptions are attached to the dialog reference on creation.

482feb8

Added CloseOnNavigation property to determine if the dialog should be…

174f38b

… closed on navigation.

Implement DialogOptions.CloseOnNavigation

c579082

Note: The DismissAll function is copied over instead of edited, as it is public, to avoid unnecessary api changes.

Formatting

77cf33a

Merge branch 'MudBlazor:dev' into fix-MudBlazor#10397

b63a2c2

mudbot bot added the enhancement Adds a new feature or enhances existing functionality (not fixing a defect) in the main library label Jan 13, 2026

aaronleev and others added 13 commits January 13, 2026 18:05

Merge branch 'MudBlazor:dev' into fix-MudBlazor#10397

3b9d5b3

Update DialogTests.cs

89d6df5

Add test dialogs being dismissed when navigating when the CloseOnNavigation option is false.

Fix build issue.

e8262e7

Fix whitespace.

5116f05

Added NotifyLocationChanged so LocationChanged events can be tested.

919ba1c

DialogOptions can now be injected into the reference for future use.

094b100

added test navigation.

eff238d

Add doc example of the feature.

0ecf569

Split Unit test

01cf77d

Revert

64ea638

Revert

033f9ce

Since mud services, specificly MudDialogProvider actaully interact wi…

668eb68

…th a real NavigationManager we need to use BunitNavigationManager instead of MockNavigationManager.

Merge remote-tracking branch 'origin/fix-#10397' into fix-MudBlazor#1…

88abb94

…0397

aaronleev changed the title ~~MudDialogProvider: Added CloseOnNavigation to DialogOptions to optionally close dialogs on navigation. (10397)~~ MudDialogProvider: Added CloseOnNavigation to DialogOptions to optionally close dialogs on navigation. (#10397) Jan 14, 2026

avalerio added 8 commits January 14, 2026 12:50

Added testable check for CloseOnNavigation usage.

4f52097

Add tests for InjectOptions, SetOptions, and ShouldDismissOnNavigation

721c1a0

Whitespace.

fa6fea7

Code coverage.

c916666

Whitespace.

481e6c3

Code coverage.

df6e6df

Test for null CloseOnNavigation

b601329

Whitespace.

e52e787

avalerio added 4 commits February 4, 2026 09:18

Add special handling for when options is null or CloseOnNavigation is…

166c04d

… null instead of default to true.

Add tests for special handling of null options and CloseOnNavigation …

79ae8af

…default value (null)

Add TriState to Checkbox as the null state is valid and has special h…

a008355

…andling.

Merge remote-tracking branch 'origin/fix-#10397' into fix-MudBlazor#1…

df687e5

…0397

danielchalmers requested a review from Copilot February 4, 2026 17:43

Copilot started reviewing on behalf of danielchalmers February 4, 2026 17:43 View session

Copilot AI reviewed Feb 4, 2026

View reviewed changes

danielchalmers merged commit ff8242d into MudBlazor:dev Feb 4, 2026
16 checks passed

dependabot bot mentioned this pull request Feb 11, 2026

Bump MudBlazor from 9.0.0-preview.2 to 9.0.0-rc.1 VladislavAntonyuk/vladislavantonyuk.github.io#143

Closed

ScarletKuro mentioned this pull request Feb 11, 2026

v9.0.0 Migration Guide #12666

Open

9 tasks

dependabot bot mentioned this pull request Feb 12, 2026

Bump MudBlazor from 9.0.0-preview.2 to 9.0.0-rc.1 MyNihongo/MudBlazor.Markdown#382

Merged

		var reference = await service.ShowAsync<DialogOkCancel>();
		reference.InjectOptions(null);

	void InjectOptions(DialogOptions options);
	void InjectOptions(DialogOptions? options);

	public void InjectOptions(DialogOptions options)
	public void InjectOptions(DialogOptions? options)

Uh oh!

Comments

Conversation

aaronleev commented Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aaronleev commented Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

aaronleev Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

aaronleev Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

aaronleev Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

aaronleev Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

aaronleev Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

danielchalmers commented Feb 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

aaronleev commented Jan 13, 2026 •

edited

Loading

aaronleev commented Feb 4, 2026 •

edited

Loading

aaronleev Feb 4, 2026 •

edited

Loading

aaronleev Feb 4, 2026 •

edited

Loading