From f63d97da0434955cd4bda9ecd5e2273d345bde3b Mon Sep 17 00:00:00 2001 From: Marc Chouteau Date: Wed, 24 Jun 2026 14:33:31 +0200 Subject: [PATCH] Update dialog backdrop close logic, docs, and tests - Change DialogOptions.CloseOnBackdropClick default to false - Update docs to reflect new default and clarify usage - SuperDialog only closes on backdrop click if enabled - OpenAsync now closes previous dialog instead of throwing - Close button now calls DialogService.Close(null) directly - Bump version to 2.0.6 - Add bUnit/MSTest tests for dialog behaviors --- SUPERDIALOGS.md | 22 ++-- .../Components/Dialogs/DialogOptions.cs | 2 +- .../Components/Dialogs/SuperDialog.razor | 2 +- .../Components/Dialogs/SuperDialog.razor.cs | 4 +- .../Services/SuperDialogService.cs | 2 +- .../SuperBlazorComponents.csproj | 2 +- .../SuperDialogTests.cs | 111 ++++++++++++++++++ 7 files changed, 124 insertions(+), 21 deletions(-) create mode 100644 tests/SuperBlazorComponents.Tests/SuperDialogTests.cs diff --git a/SUPERDIALOGS.md b/SUPERDIALOGS.md index 6975480..695bcaf 100644 --- a/SUPERDIALOGS.md +++ b/SUPERDIALOGS.md @@ -167,7 +167,7 @@ Listens to `SuperDialogService.OnShow`. Renders a Bootstrap modal with a single |---|---|---|---| | `Width` | `string?` | `null` | Custom max-width (e.g. `"500px"`, `"80%"`) | | `Height` | `string?` | `null` | Custom modal body height with auto overflow | -| `CloseOnBackdropClick` | `bool` | `true` | Click outside closes the modal (returns `null`) | +| `CloseOnBackdropClick` | `bool` | `false` | Click outside closes the modal when enabled (returns `null`) | | `ShowCloseButton` | `bool` | `true` | Shows the `×` icon in the header | | `CssClass` | `string?` | `null` | Extra CSS class on `.modal-content` | | `Size` | `DialogSize` | `Default` | `Default`, `Small`, `Large`, `ExtraLarge` | @@ -270,13 +270,12 @@ var options = new DialogOptions await DialogService.OpenAsync("Edit", null, options); ``` -### 5. Disable backdrop close (force a choice) +### 5. Keep the dialog open on backdrop click (default) ```csharp await DialogService.OpenAsync("Terms of service", null, new DialogOptions { - CloseOnBackdropClick = false, ShowCloseButton = false }); ``` @@ -342,17 +341,11 @@ await DialogService.Confirm( } ``` -### 10. Re-entrancy guard +### 10. Reopening a dynamic dialog ```csharp -try -{ - await DialogService.OpenAsync("Edit"); -} -catch (InvalidOperationException) -{ - // a dialog is already open — ignore or queue -} +// If another dynamic dialog is still open, it is closed with a null result first. +await DialogService.OpenAsync("Edit"); ``` --- @@ -363,7 +356,7 @@ catch (InvalidOperationException) - ✅ For destructive actions, prefer **`SuperConfirmationButton`** (see [SUPERBUTTONS.md](SUPERBUTTONS.md)) — it wraps the confirm flow for free. - ✅ Make dialog components self-sufficient: inject `SuperDialogService` and call `Close(value)` to return their result. - ✅ Use **`DialogSize.ExtraLarge`** + custom `Width` for editor-style dialogs. -- ⚠️ Only **one** dialog of each kind (confirm / dynamic) can be open at a time — opening another throws `InvalidOperationException`. +- ⚠️ Only **one** dialog of each kind (confirm / dynamic) can be visible at a time. Opening a dynamic dialog closes the previous dynamic dialog first. - ⚠️ Avoid heavy initialization inside dialog components; they are mounted on every open. --- @@ -373,9 +366,8 @@ catch (InvalidOperationException) | Symptom | Cause | Fix | |---|---|---| | `InvalidOperationException: No dialog host is registered` | `` not placed in layout | Add it once to `MainLayout.razor` | -| `InvalidOperationException: A dialog is already open` | Concurrent `OpenAsync` calls | Await previous call or guard with try/catch | | Dialog never returns | Component never calls `DialogService.Close(...)` | Ensure all close paths call `Close(result)` | -| Backdrop click discards user input | Default behavior | Set `CloseOnBackdropClick = false` | +| Backdrop click does not close the dialog | Default behavior | Set `CloseOnBackdropClick = true` | | `result` is `null` when expected | User dismissed via backdrop/× | Check for `null` and treat as cancellation | --- diff --git a/src/SuperBlazorComponents/Components/Dialogs/DialogOptions.cs b/src/SuperBlazorComponents/Components/Dialogs/DialogOptions.cs index e1a3c51..e4a4da8 100644 --- a/src/SuperBlazorComponents/Components/Dialogs/DialogOptions.cs +++ b/src/SuperBlazorComponents/Components/Dialogs/DialogOptions.cs @@ -18,7 +18,7 @@ public class DialogOptions /// /// Indique si la modale peut être fermée en cliquant sur le fond. /// - public bool CloseOnBackdropClick { get; set; } = true; + public bool CloseOnBackdropClick { get; set; } = false; /// /// Indique si la modale affiche un bouton de fermeture. diff --git a/src/SuperBlazorComponents/Components/Dialogs/SuperDialog.razor b/src/SuperBlazorComponents/Components/Dialogs/SuperDialog.razor index 16c4357..78f5e9a 100644 --- a/src/SuperBlazorComponents/Components/Dialogs/SuperDialog.razor +++ b/src/SuperBlazorComponents/Components/Dialogs/SuperDialog.razor @@ -12,7 +12,7 @@
@_title
@if (_options?.ShowCloseButton ?? true) { - + }
diff --git a/src/SuperBlazorComponents/Components/Dialogs/SuperDialog.razor.cs b/src/SuperBlazorComponents/Components/Dialogs/SuperDialog.razor.cs index 80ddb65..e316e2d 100644 --- a/src/SuperBlazorComponents/Components/Dialogs/SuperDialog.razor.cs +++ b/src/SuperBlazorComponents/Components/Dialogs/SuperDialog.razor.cs @@ -35,7 +35,7 @@ private async Task CloseDialog() private async Task OnBackdropClick() { - if (_options?.CloseOnBackdropClick ?? true) + if (_options?.CloseOnBackdropClick ?? false) { await DialogService.Close(null); } @@ -82,4 +82,4 @@ public void Dispose() DialogService.OnOpenDialog -= ShowDialog; DialogService.OnCloseDialog -= CloseDialog; } -} \ No newline at end of file +} diff --git a/src/SuperBlazorComponents/Services/SuperDialogService.cs b/src/SuperBlazorComponents/Services/SuperDialogService.cs index eb7a51d..344aae8 100644 --- a/src/SuperBlazorComponents/Services/SuperDialogService.cs +++ b/src/SuperBlazorComponents/Services/SuperDialogService.cs @@ -93,7 +93,7 @@ internal void SetResult(bool result) { if (_dialogTcs is { Task.IsCompleted: false }) { - throw new InvalidOperationException("A dialog is already open."); + await Close(null); } if (OnOpenDialog is null) diff --git a/src/SuperBlazorComponents/SuperBlazorComponents.csproj b/src/SuperBlazorComponents/SuperBlazorComponents.csproj index 4608746..58c3d59 100644 --- a/src/SuperBlazorComponents/SuperBlazorComponents.csproj +++ b/src/SuperBlazorComponents/SuperBlazorComponents.csproj @@ -4,7 +4,7 @@ net10.0 enable enable - 2.0.5 + 2.0.6 false SuperBlazorComponents SuperBlazorComponents diff --git a/tests/SuperBlazorComponents.Tests/SuperDialogTests.cs b/tests/SuperBlazorComponents.Tests/SuperDialogTests.cs new file mode 100644 index 0000000..7fb2c1d --- /dev/null +++ b/tests/SuperBlazorComponents.Tests/SuperDialogTests.cs @@ -0,0 +1,111 @@ +using Bunit; +using Microsoft.AspNetCore.Components; +using Microsoft.AspNetCore.Components.Rendering; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.VisualStudio.TestTools.UnitTesting; +using SuperBlazorComponents.Components.Dialogs; +using SuperBlazorComponents.Services; + +namespace SuperBlazorComponents.Tests; + +[TestClass] +public sealed class SuperDialogTests : BunitContext +{ + [TestInitialize] + public void Setup() + { + Services.AddLocalization(); + Services.AddScoped(); + } + + [TestCleanup] + public void Cleanup() + { + Dispose(); + } + + [TestMethod] + public async Task CloseButton_CompletesOpenAsync() + { + var cut = Render(); + var dialogService = Services.GetRequiredService(); + + var openTask = cut.InvokeAsync(() => dialogService.OpenAsync("Title")); + + cut.WaitForAssertion(() => Assert.AreEqual("Title", cut.Find(".modal-title").TextContent)); + + cut.Find(".btn-close").Click(); + + var result = await openTask.WaitAsync(TimeSpan.FromSeconds(1)); + Assert.IsNull(result); + Assert.AreEqual(0, cut.FindAll(".modal").Count); + } + + [TestMethod] + public async Task BackdropClick_Default_KeepsDialogOpen() + { + var cut = Render(); + var dialogService = Services.GetRequiredService(); + + var openTask = cut.InvokeAsync(() => dialogService.OpenAsync("Title")); + + cut.WaitForAssertion(() => Assert.AreEqual("Title", cut.Find(".modal-title").TextContent)); + + cut.Find(".modal").Click(); + + Assert.IsFalse(openTask.IsCompleted); + Assert.AreEqual("Title", cut.Find(".modal-title").TextContent); + + await cut.InvokeAsync(() => dialogService.Close(null)); + await openTask.WaitAsync(TimeSpan.FromSeconds(1)); + } + + [TestMethod] + public async Task BackdropClick_WhenEnabled_CompletesOpenAsync() + { + var cut = Render(); + var dialogService = Services.GetRequiredService(); + + var openTask = cut.InvokeAsync(() => dialogService.OpenAsync( + "Title", + options: new DialogOptions { CloseOnBackdropClick = true })); + + cut.WaitForAssertion(() => Assert.AreEqual("Title", cut.Find(".modal-title").TextContent)); + + cut.Find(".modal").Click(); + + var result = await openTask.WaitAsync(TimeSpan.FromSeconds(1)); + Assert.IsNull(result); + Assert.AreEqual(0, cut.FindAll(".modal").Count); + } + + [TestMethod] + public async Task OpenAsync_WhenDialogIsAlreadyOpen_ClosesPreviousDialog() + { + var cut = Render(); + var dialogService = Services.GetRequiredService(); + + var firstOpenTask = cut.InvokeAsync(() => dialogService.OpenAsync("First")); + + cut.WaitForAssertion(() => Assert.AreEqual("First", cut.Find(".modal-title").TextContent)); + + var secondOpenTask = cut.InvokeAsync(() => dialogService.OpenAsync("Second")); + + var firstResult = await firstOpenTask.WaitAsync(TimeSpan.FromSeconds(1)); + Assert.IsNull(firstResult); + cut.WaitForAssertion(() => Assert.AreEqual("Second", cut.Find(".modal-title").TextContent)); + + await cut.InvokeAsync(() => dialogService.Close("done")); + + var secondResult = await secondOpenTask.WaitAsync(TimeSpan.FromSeconds(1)); + Assert.AreEqual("done", secondResult); + } + + private sealed class TestDialog : ComponentBase + { + protected override void BuildRenderTree(RenderTreeBuilder builder) + { + builder.AddContent(0, "Test dialog"); + } + } +}