feat(ICloseable): add ICloseable interface (#7644)

* feat(IClosable): add IClosable interface

* refactor: 更新单词拼写

* refactor: 更正变量名

* refactor: 移除标签

* test: 移除 AddMockEnvironment 服务

* test: 消除警告信息

* test: 更新单元测试

* doc: 更新 xml 注释

* refactor: 更新逻辑

* chore: bump version 10.3.2-beta02

Author: ArgoZhang

src/BootstrapBlazor/BootstrapBlazor.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Razor">
 
   <PropertyGroup>
-    <Version>10.3.2-beta01</Version>
+    <Version>10.3.2-beta02</Version>
   </PropertyGroup>
 
   <ItemGroup>

src/BootstrapBlazor/Components/Dialog/Dialog.razor

@@ -2,7 +2,7 @@
 @inherits BootstrapComponentBase
 
 <Modal @ref="_modal" IsBackdrop="_isBackdrop" IsKeyboard="@_isKeyboard" IsFade="_isFade"
-       OnShownAsync="_onShownAsync" OnCloseAsync="_onCloseAsync"
+       OnShownAsync="_onShownAsync" OnClosingAsync="_onClosingAsync" OnCloseAsync="_onCloseAsync"
        class="@ClassString">
     @for (var index = 0; index < DialogParameters.Keys.Count; index++)
     {

src/BootstrapBlazor/Components/Dialog/Dialog.razor.cs

@@ -19,6 +19,7 @@ public partial class Dialog : IDisposable
     private Modal? _modal = null;
     private Func<Task>? _onShownAsync = null;
     private Func<Task>? _onCloseAsync = null;
+    private Func<Task<bool>>? _onClosingAsync = null;
 
     private readonly Dictionary<Dictionary<string, object>, (bool IsKeyboard, bool IsBackdrop, Func<Task>? OnCloseCallback)> DialogParameters = [];
     private Dictionary<string, object>? _currentParameter;
@@ -87,6 +88,8 @@ private async Task Show(DialogOption option)
             }
         };
 
+        _onClosingAsync = option.OnClosingAsync;
+
         _isKeyboard = option.IsKeyboard;
         _isBackdrop = option.IsBackdrop;
         _isFade = option.IsFade;

src/BootstrapBlazor/Components/Dialog/DialogOption.cs

@@ -9,7 +9,7 @@ namespace BootstrapBlazor.Components;
 /// <para lang="zh">Dialog 对话框组件</para>
 /// <para lang="en">Dialog component</para>
 /// </summary>
-public class DialogOption
+public class DialogOption : ICloseable
 {
     /// <summary>
     /// <para lang="zh">获得/设置 关联的 Modal 实例</para>
@@ -192,11 +192,15 @@ public class DialogOption
     public string? CloseButtonText { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 关闭对话框回调方法</para>
-    /// <para lang="en">Gets or sets the callback method for closing the dialog</para>
+    /// <inheritdoc cref="ICloseable.OnCloseAsync"/>
     /// </summary>
     public Func<Task>? OnCloseAsync { get; set; }
 
+    /// <summary>
+    /// <inheritdoc cref="ICloseable.OnClosingAsync"/>
+    /// </summary>
+    public Func<Task<bool>>? OnClosingAsync { get; set; }
+
     /// <summary>
     /// <para lang="zh">获得/设置 是否自动关闭对话框（保存成功后） 默认值为 true</para>
     /// <para lang="en">Gets or sets whether to automatically close the dialog after saving successfully, default is true</para>

src/BootstrapBlazor/Components/Modal/IClosable.cs

@@ -0,0 +1,25 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License
+// See the LICENSE file in the project root for more information.
+// Maintainer: Argo Zhang(argo@live.ca) Website: https://www.blazor.zone
+
+namespace BootstrapBlazor.Components;
+
+/// <summary>
+/// <para lang="zh">可关闭接口</para>
+/// <para lang="en">the closable interface</para>
+/// </summary>
+public interface ICloseable
+{
+    /// <summary>
+    /// <para lang="zh">获得/设置 弹出窗口关闭时的回调委托</para>
+    /// <para lang="en">Gets or sets the callback delegate when the popup is closed</para>
+    /// </summary>
+    Func<Task>? OnCloseAsync { get; set; }
+
+    /// <summary>
+    /// <para lang="zh">关闭之前回调方法 返回 true 时关闭弹窗 返回 false 时阻止关闭弹窗</para>
+    /// <para lang="en">Callback Method Before Closing. Return true to close, false to prevent closing</para>
+    /// </summary>
+    Func<Task<bool>>? OnClosingAsync { get; set; }
+}

src/BootstrapBlazor/Components/Modal/Modal.razor.cs

@@ -11,7 +11,7 @@ namespace BootstrapBlazor.Components;
 /// <para lang="zh">Modal 组件</para>
 /// <para lang="en">Modal component</para>
 /// </summary>
-public partial class Modal
+public partial class Modal : ICloseable
 {
     [Inject]
     [NotNull]
@@ -77,15 +77,13 @@ public partial class Modal
     public Func<Task>? OnShownAsync { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 弹出窗口关闭时的回调委托</para>
-    /// <para lang="en">Gets or sets the callback delegate when the popup is closed</para>
+    /// <inheritdoc cref="ICloseable.OnCloseAsync"/>
     /// </summary>
     [Parameter]
     public Func<Task>? OnCloseAsync { get; set; }
 
     /// <summary>
-    /// <para lang="zh">关闭之前回调方法 返回 true 时关闭弹窗 返回 false 时阻止关闭弹窗</para>
-    /// <para lang="en">Callback Method Before Closing. Return true to close, false to prevent closing</para>
+    /// <inheritdoc cref="ICloseable.OnClosingAsync"/>
     /// </summary>
     [Parameter]
     public Func<Task<bool>>? OnClosingAsync { get; set; }

src/BootstrapBlazor/Extensions/PropertyInfoExtensions.cs

@@ -26,7 +26,7 @@ public static bool IsStatic(this PropertyInfo p)
 
     /// <summary>
     /// <para lang="zh">判断属性是否可以写入扩展方法</para>
-    /// <para lang="en">Determines whether the property can be written to extension method</para>
+    /// <para lang="en">Determines whether the property can be written to</para>
     /// </summary>
     /// <param name="p"></param>
     public static bool IsCanWrite(this PropertyInfo p) => p.CanWrite && !p.IsInit();

src/BootstrapBlazor/Utils/BootstrapDynamicComponent.cs

@@ -62,14 +62,14 @@ public RenderFragment<TModel> RenderEditTemplate<TModel>(string? modelParameterN
     {
         var index = 0;
         builder.OpenComponent(index++, componentType);
+        modelParameterName ??= "Model";
+        var modelProperty = componentType.GetPropertyByName(modelParameterName);
+        if (modelProperty.HasParameterAttribute(typeof(TModel)))
+        {
+            builder.AddAttribute(index++, modelParameterName, model);
+        }
         if (parameters != null)
         {
-            modelParameterName ??= "Model";
-            var modelProperty = componentType.GetPropertyByName(modelParameterName);
-            if (modelProperty.HasParameterAttribute(typeof(TModel)))
-            {
-                builder.AddAttribute(index++, modelParameterName, model);
-            }
             foreach (var p in parameters)
             {
                 builder.AddAttribute(index++, p.Key, p.Value);

test/UnitTest/Components/DialogTest.cs

@@ -583,6 +583,22 @@ await cut.InvokeAsync(() => dialog.ShowCloseDialog<MockValidateFormDialog>("Clos
         await cut.InvokeAsync(() => dialog.ShowExceptionDialog(null, new Exception("Test")));
         await cut.InvokeAsync(() => modal.Instance.CloseCallback());
         #endregion
+
+        // OnClosing
+        var closing = false;
+        await cut.InvokeAsync(() => dialog.Show(new DialogOption()
+        {
+            OnClosingAsync = () =>
+            {
+                closing = true;
+                return Task.FromResult(false);
+            }
+        }));
+
+        // 由于返回 false 所以关窗方法被阻止
+        await cut.InvokeAsync(() => modal.Instance.Close());
+        Assert.True(closing);
+        await cut.InvokeAsync(() => modal.Instance.CloseCallback());
     }
 
     private class MockValidateFormDialog : ComponentBase

test/UnitTest/Core/TestBase.cs

@@ -13,16 +13,12 @@ public TestBase()
     {
         Context = new BunitContext();
         Context.JSInterop.Mode = JSRuntimeMode.Loose;
-
-        Context.Services.AddMockEnvironment();
     }
 
     public void Dispose()
     {
-#pragma warning disable CA2012
         // 由于 bUnit 2.0 继承了 IAsyncDisposable 接口，因此此处调用 DisposeAsync 方法
-        Context.DisposeAsync();
-#pragma warning restore CA2012
+        Context.DisposeAsync().AsTask().Wait();
         GC.SuppressFinalize(this);
     }
 }