fix(ITableColumn): add GetTooltipText method (#4889)

ArgoZhang · web-flow · commit 06ed5f019b5a · 2024-12-19T09:41:39.000+08:00
* doc: 代码格式化

* refactor: 增加 GetTooltipText 属性

* doc: 更新示例

* test: 更新单元测试

* refactor: 消除警告信息

* test: 提高代码覆盖率

* refactor: 重构代码

* doc: 更新文档

* doc: 更新文档
diff --git a/src/BootstrapBlazor.Server/Components/Samples/Table/TablesWrap.razor b/src/BootstrapBlazor.Server/Components/Samples/Table/TablesWrap.razor
@@ -71,7 +71,7 @@
         <TableColumns>
             <TableColumn @bind-Field="@context.DateTime" Width="180" Text="@Localizer["TablesWrapDataResizingColumHeaderText_DateTime"]" />
             <TableColumn @bind-Field="@context.Name" Text="@Localizer["TablesWrapDataResizingColumHeaderText_Name"]" />
-            <TableColumn @bind-Field="@context.Address" Text="@Localizer["TablesWrapDataResizingColumHeaderText_Address"]" Width="200" TextEllipsis="true" ShowTips="true" GetTooltipTextCallback="GetTooltipTextCallback" />
+            <TableColumn @bind-Field="@context.Address" Text="@Localizer["TablesWrapDataResizingColumHeaderText_Address"]" Width="200" TextEllipsis="true" ShowTips="true" GetTooltipText="GetTooltipText" />
             <TableColumn @bind-Field="@context.Education" />
             <TableColumn @bind-Field="@context.Count" />
             <TableColumn @bind-Field="@context.Complete" />
diff --git a/src/BootstrapBlazor.Server/Components/Samples/Table/TablesWrap.razor.cs b/src/BootstrapBlazor.Server/Components/Samples/Table/TablesWrap.razor.cs
@@ -38,14 +38,12 @@ private Task<QueryData<Foo>> OnQueryAsync(QueryPageOptions options)
         return Task.FromResult(new QueryData<Foo>() { Items = items, TotalCount = total, IsSorted = true, IsFiltered = true, IsSearch = true });
     }
 
-    private async Task<string?> GetTooltipTextCallback(object? v)
+    private static string? GetTooltipText(object? v)
     {
-        await Task.Delay(0);
-
         var ret = string.Empty;
         if (v is Foo foo)
         {
-            ret = $"{foo.Name}-{DateTime.Now}";
+            ret = $"{foo.Name}-{foo.Address}";
         }
         return ret;
     }
diff --git a/src/BootstrapBlazor.Server/Locales/en-US.json b/src/BootstrapBlazor.Server/Locales/en-US.json
@@ -5265,7 +5265,7 @@
     "TablesWrapDataResizingTips1": "You can drag the window size, and the <b>address</b> column will be automatically omitted if the window is too small",
     "TablesWrapDataResizingTips2": "Enable text ellipsis by setting <code>TextEllipsis</code>",
     "TablesWrapDataResizingTips3": "<b>Note:</b> It is recommended to use <code>Width</code> to set the column width. If the column width is not set, it will automatically use 200px width inside",
-    "TablesWrapDataResizingTips4": "After the text in the cell is omitted, you can use the <code>ShowTips</code> property to control whether to display all the text on mouse hover, the default is <code>false</code>, You can customize the display content of <code>Tooltip</code> by setting the <code>GetTooltipTextCallback</code> callback method",
+    "TablesWrapDataResizingTips4": "After the text in the cell is omitted, you can use the <code>ShowTips</code> property to control whether to display all the text on mouse hover, the default is <code>false</code>, You can customize the display content of <code>Tooltip</code> by setting the <code>GetTooltipText</code> callback method",
     "TablesWrapDataResizingTips5": "Drag the address column, the cell display content will automatically increase and decrease",
     "TablesWrapCustomCellTitle": "Custom in-cell typography",
     "TablesWrapCustomCellIntro": "Use templates for special layout of in-cell data",
diff --git a/src/BootstrapBlazor.Server/Locales/zh-CN.json b/src/BootstrapBlazor.Server/Locales/zh-CN.json
@@ -5265,7 +5265,7 @@
     "TablesWrapDataResizingTips1": "可以拖动窗口大小，窗口过小时 <b>地址</b> 列自动进行省略处理",
     "TablesWrapDataResizingTips2": "通过设置 <code>TextEllipsis</code> 来开启文本超长省略功能",
     "TablesWrapDataResizingTips3": "<b>注意：</b>推荐使用 <code>Width</code> 对列宽度进行设置，如未设置列宽内部自动使用 200px 宽度",
-    "TablesWrapDataResizingTips4": "单元格内文本被省略后，可以通过 <code>ShowTips</code> 属性来控制鼠标悬停是否显示全部文本，默认为 <code>false</code>，通过设置 <code>GetTooltipTextCallback</code> 回调方法可以自定义 <code>Tooltip</code> 显示内容",
+    "TablesWrapDataResizingTips4": "单元格内文本被省略后，可以通过 <code>ShowTips</code> 属性来控制鼠标悬停是否显示全部文本，默认为 <code>false</code>，通过设置 <code>GetTooltipText</code> 回调方法可以自定义 <code>Tooltip</code> 显示内容；注意异步方法 <code>GetTooltipTextCallback</code> 已弃用请勿使用",
     "TablesWrapDataResizingTips5": "拖动地址列，单元格显示内容自动增加与减少",
     "TablesWrapCustomCellTitle": "自定义单元格内排版",
     "TablesWrapCustomCellIntro": "使用模板对单元格内数据进行特殊布局",
diff --git a/src/BootstrapBlazor/Attributes/AutoGenerateColumnAttribute.cs b/src/BootstrapBlazor/Attributes/AutoGenerateColumnAttribute.cs
@@ -203,8 +203,15 @@ public class AutoGenerateColumnAttribute : AutoGenerateBaseAttribute, ITableColu
     /// <summary>
     /// <inheritdoc/>
     /// </summary>
+    [Obsolete("已弃用，请使用同步方法 GetTooltipText；Deprecated, please use the synchronous method GetTooltipText")]
+    [ExcludeFromCodeCoverage]
     Func<object?, Task<string?>>? ITableColumn.GetTooltipTextCallback { get; set; }
 
+    /// <summary>
+    /// <inheritdoc/>
+    /// </summary>
+    Func<object?, string?>? ITableColumn.GetTooltipText { get; set; }
+
     /// <summary>
     /// <inheritdoc/>
     /// </summary>
diff --git a/src/BootstrapBlazor/Components/Filters/LookupFilter.razor.cs b/src/BootstrapBlazor/Components/Filters/LookupFilter.razor.cs
@@ -96,9 +96,9 @@ protected override async Task OnParametersSetAsync()
         await base.OnParametersSetAsync();
 
         var items = new List<SelectedItem>
-            {
-                new("", Localizer["EnumFilter.AllText"].Value)
-            };
+        {
+            new("", Localizer["EnumFilter.AllText"].Value)
+        };
         if (Lookup != null)
         {
             items.AddRange(Lookup);
diff --git a/src/BootstrapBlazor/Components/Table/ITableColumn.cs b/src/BootstrapBlazor/Components/Table/ITableColumn.cs
@@ -143,8 +143,15 @@ public interface ITableColumn : IEditorItem
     /// <summary>
     /// 获得/设置 鼠标悬停提示自定义内容回调委托 默认 null 使用当前值
     /// </summary>
+    [Obsolete("已弃用，请使用同步方法 GetTooltipText；Deprecated, please use the synchronous method GetTooltipText")]
+    [ExcludeFromCodeCoverage]
     Func<object?, Task<string?>>? GetTooltipTextCallback { get; set; }
 
+    /// <summary>
+    /// 获得/设置 鼠标悬停提示自定义内容回调委托 默认 null 使用当前值
+    /// </summary>
+    Func<object?, string?>? GetTooltipText { get; set; }
+
     /// <summary>
     /// 获得/设置 单元格回调方法
     /// </summary>
diff --git a/src/BootstrapBlazor/Components/Table/InternalTableColumn.cs b/src/BootstrapBlazor/Components/Table/InternalTableColumn.cs
@@ -133,8 +133,18 @@ class InternalTableColumn(string fieldName, Type fieldType, string? fieldText =
 
     public bool? ShowTips { get; set; }
 
+    /// <summary>
+    /// <inheritdoc/>
+    /// </summary>
+    [Obsolete("已弃用，请使用同步方法 GetTooltipText；Deprecated, please use the synchronous method GetTooltipText")]
+    [ExcludeFromCodeCoverage]
     public Func<object?, Task<string?>>? GetTooltipTextCallback { get; set; }
 
+    /// <summary>
+    /// <inheritdoc/>
+    /// </summary>
+    public Func<object?, string?>? GetTooltipText { get; set; }
+
     public Type PropertyType { get; } = fieldType;
 
     [ExcludeFromCodeCoverage]
diff --git a/src/BootstrapBlazor/Components/Table/TableColumn.cs b/src/BootstrapBlazor/Components/Table/TableColumn.cs
@@ -269,8 +269,16 @@ public class TableColumn<TItem, TType> : BootstrapComponentBase, ITableColumn
     /// <inheritdoc/>
     /// </summary>
     [Parameter]
+    [Obsolete("已弃用，请使用同步方法 GetTooltipText；Deprecated, please use the synchronous method GetTooltipText")]
+    [ExcludeFromCodeCoverage]
     public Func<object?, Task<string?>>? GetTooltipTextCallback { get; set; }
 
+    /// <summary>
+    /// <inheritdoc/>
+    /// </summary>
+    [Parameter]
+    public Func<object?, string?>? GetTooltipText { get; set; }
+
     /// <summary>
     /// 获得/设置 列 td 自定义样式 默认为 null 未设置
     /// </summary>
diff --git a/src/BootstrapBlazor/Extensions/ITableColumnExtensions.cs b/src/BootstrapBlazor/Extensions/ITableColumnExtensions.cs
@@ -105,7 +105,7 @@ private static void CopyValue(this ITableColumn col, ITableColumn dest)
         if (col.IsVisibleWhenEdit.HasValue) dest.IsVisibleWhenEdit = col.IsVisibleWhenEdit;
         if (col.IsReadonlyWhenAdd.HasValue) dest.IsReadonlyWhenAdd = col.IsReadonlyWhenAdd;
         if (col.IsReadonlyWhenEdit.HasValue) dest.IsReadonlyWhenEdit = col.IsReadonlyWhenEdit;
-        if (col.GetTooltipTextCallback != null) dest.GetTooltipTextCallback = col.GetTooltipTextCallback;
+        if (col.GetTooltipText != null) dest.GetTooltipText = col.GetTooltipText;
         if (col.CustomSearch != null) dest.CustomSearch = col.CustomSearch;
         if (col.ToolboxTemplate != null) dest.ToolboxTemplate = col.ToolboxTemplate;
         if (col.IsRequiredWhenAdd.HasValue) dest.IsRequiredWhenAdd = col.IsRequiredWhenAdd;
@@ -238,14 +238,14 @@ internal static RenderFragment RenderColor<TItem>(this ITableColumn col, TItem i
         builder.CloseElement();
     };
 
-    private static RenderFragment RenderTooltip<TItem>(this ITableColumn col, string? text, TItem item) => async pb =>
+    private static RenderFragment RenderTooltip<TItem>(this ITableColumn col, string? text, TItem item) => pb =>
     {
         if (col.GetShowTips())
         {
             var tooltipText = text;
-            if (col.GetTooltipTextCallback != null)
+            if (col.GetTooltipText != null)
             {
-                tooltipText = await col.GetTooltipTextCallback(item);
+                tooltipText = col.GetTooltipText(item);
             }
             pb.OpenComponent<Tooltip>(0);
             pb.AddAttribute(1, nameof(Tooltip.Title), tooltipText);
diff --git a/test/UnitTest/Attributes/AutoGenerateClassTest.cs b/test/UnitTest/Attributes/AutoGenerateClassTest.cs
@@ -156,8 +156,8 @@ public void AutoGenerateColumn_Ok()
         attrInterface.IsReadonlyWhenEdit = true;
         Assert.True(attrInterface.IsReadonlyWhenEdit);
 
-        attrInterface.GetTooltipTextCallback = _ => Task.FromResult((string?)"Test");
-        Assert.NotNull(attrInterface.GetTooltipTextCallback);
+        attrInterface.GetTooltipText = _ => "Test";
+        Assert.NotNull(attrInterface.GetTooltipText);
 
         attrInterface.CustomSearch = (_, _) => new SearchFilterAction("test", "test");
         Assert.NotNull(attrInterface.CustomSearch);
diff --git a/test/UnitTest/Components/TableColumnTest.cs b/test/UnitTest/Components/TableColumnTest.cs
@@ -77,7 +77,7 @@ public void InternalTableColumn_Ok()
         SetValue("HeaderTextTooltip", "Test");
         SetValue("HeaderTextEllipsis", true);
         SetValue("IsMarkupString", true);
-        SetValue("GetTooltipTextCallback", new Func<object, Task<string?>>(_ => Task.FromResult((string?)"")));
+        SetValue("GetTooltipText", new Func<object, string?>(_ => ""));
         SetValue("CustomSearch", new Func<ITableColumn, string?, SearchFilterAction>((_, _) => new SearchFilterAction("test", "test")));
 
         SetValue("Required", true);
diff --git a/test/UnitTest/Components/TableTest.cs b/test/UnitTest/Components/TableTest.cs
@@ -1823,7 +1823,7 @@ public void Column_IsFixedDetailColumn()
 
     class MockTableColumn : AutoGenerateColumnAttribute
     {
-        public new string GetFieldName() => "Test";
+        public static new string GetFieldName() => "Test";
     }
 
     [Fact]
@@ -4916,7 +4916,7 @@ public void ShowTips_Ok(bool markup)
     }
 
     [Fact]
-    public void GetTooltipTextCallback_Ok()
+    public void GetTooltipText_Ok()
     {
         var localizer = Context.Services.GetRequiredService<IStringLocalizer<Foo>>();
         var items = Foo.GenerateFoo(localizer, 2);
@@ -4934,9 +4934,8 @@ public void GetTooltipTextCallback_Ok()
                     builder.AddAttribute(3, "Editable", true);
                     builder.AddAttribute(7, "Text", "test");
                     builder.AddAttribute(9, "ShowTips", true);
-                    builder.AddAttribute(10, "GetTooltipTextCallback", new Func<object, Task<string?>>(async v =>
+                    builder.AddAttribute(10, "GetTooltipText", new Func<object, string?>(v =>
                     {
-                        await Task.Delay(0);
                         return "test-tips-callback";
                     }));
                     builder.CloseComponent();
diff --git a/test/UnitTest/Extensions/ITableColumnExtensionsTest.cs b/test/UnitTest/Extensions/ITableColumnExtensionsTest.cs
@@ -106,7 +106,7 @@ public void CopyValue_Ok()
             Step = "0.01",
             Order = -1,
             IsMarkupString = true,
-            GetTooltipTextCallback = _ => Task.FromResult<string?>(null),
+            GetTooltipText = _ => null,
             CustomSearch = (_, _) => new SearchFilterAction("test", "test"),
 
             Required = true,
@@ -169,7 +169,7 @@ public void CopyValue_Ok()
         Assert.True(col.ShowCopyColumn);
         Assert.Equal("0.01", col.Step);
         Assert.Equal(-1, col.Order);
-        Assert.NotNull(col.GetTooltipTextCallback);
+        Assert.NotNull(col.GetTooltipText);
         Assert.True(col.IsMarkupString);
         Assert.NotNull(col.CustomSearch);
 
diff --git a/test/UnitTest/Utils/UtilityTest.cs b/test/UnitTest/Utils/UtilityTest.cs
@@ -114,7 +114,7 @@ public void GetSortListFunc_Ok()
     [Fact]
     public void GetPlaceHolder_Ok()
     {
-        var ph = Utility.GetPlaceHolder(typeof(Foo), "Name");
+        var ph = Utility.GetPlaceHolder<Foo>("Name");
         Assert.Equal("不可为空", ph);
 
         // 动态类型
@@ -353,7 +353,7 @@ public void GetDisplayName_Ok()
         dn = Utility.GetDisplayName<TestEnum>(nameof(TestEnum.Address));
         Assert.Equal("Test-Enum-Address", dn);
 
-        dn = Utility.GetDisplayName(typeof(Nullable<TestEnum>), nameof(TestEnum.Name));
+        dn = Utility.GetDisplayName<TestEnum?>(nameof(TestEnum.Name));
         Assert.Equal("Test-Enum-Name", dn);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -38,14 +38,12 @@ private Task<QueryData<Foo>> OnQueryAsync(QueryPageOptions options)`
`38`	`38`	`return Task.FromResult(new QueryData<Foo>() { Items = items, TotalCount = total, IsSorted = true, IsFiltered = true, IsSearch = true });`
`39`	`39`	`}`
`40`	`40`
`41`		`- private async Task<string?> GetTooltipTextCallback(object? v)`
	`41`	`+ private static string? GetTooltipText(object? v)`
`42`	`42`	`{`
`43`		`- await Task.Delay(0);`
`44`		`-`
`45`	`43`	`var ret = string.Empty;`
`46`	`44`	`if (v is Foo foo)`
`47`	`45`	`{`
`48`		`- ret = $"{foo.Name}-{DateTime.Now}";`
	`46`	`+ ret = $"{foo.Name}-{foo.Address}";`
`49`	`47`	`}`
`50`	`48`	`return ret;`
`51`	`49`	`}`