feat(Table): add NotSupportedColumnFilterMessage parameter (#6302)

* feat(Table): 增加  NotSupportedMessage 参数

* doc: 增加文档地址提示

* test: 更新单元测试

* refactor: 更改参数名称

* doc: 增加 html 支持

* refactor: 增加标签

Author: ArgoZhang

src/BootstrapBlazor/Components/Filters/NotSupportFilter.razor

@@ -1,4 +1,4 @@
 @namespace BootstrapBlazor.Components
 @inherits FilterBase
 
-<div>@NotSupportedMessage</div>
+<div>@(new MarkupString(NotSupportedColumnFilterMessage))</div>

src/BootstrapBlazor/Components/Filters/NotSupportFilter.razor.cs

@@ -14,7 +14,8 @@ public partial class NotSupportFilter
     /// 获得/设置 不支持过滤类型提示信息 默认 null 读取资源文件内容
     /// </summary>
     [Parameter]
-    public string? NotSupportedMessage { get; set; }
+    [NotNull]
+    public string? NotSupportedColumnFilterMessage { get; set; }
 
     /// <summary>
     /// <inheritdoc/>
@@ -23,7 +24,7 @@ protected override void OnParametersSet()
     {
         base.OnParametersSet();
 
-        NotSupportedMessage ??= Localizer[nameof(NotSupportedMessage)];
+        NotSupportedColumnFilterMessage ??= Localizer[nameof(NotSupportedColumnFilterMessage)];
     }
 
     /// <summary>

src/BootstrapBlazor/Components/Filters/TableColumnFilter.razor

@@ -89,7 +89,8 @@ else
                         break;
                     default:
                         <FilterProvider>
-                            <NotSupportFilter NotSupportedMessage="@NotSupportedMessage"></NotSupportFilter>
+                            <NotSupportFilter NotSupportedColumnFilterMessage="@NotSupportedColumnFilterMessage">
+                            </NotSupportFilter>
                         </FilterProvider>
                         break;
                 }

src/BootstrapBlazor/Components/Filters/TableColumnFilter.razor.cs

@@ -28,7 +28,15 @@ public partial class TableColumnFilter : IFilter
     /// 获得/设置 不支持过滤类型提示信息 默认 null 读取资源文件内容
     /// </summary>
     [Parameter]
-    public string? NotSupportedMessage { get; set; }
+    [ExcludeFromCodeCoverage]
+    [Obsolete("已弃用，请使用 NotSupportedColumnFilterMessage 参数; Deprecated, please use NotSupportedColumnFilterMessage parameter")]
+    public string? NotSupportedMessage { get => NotSupportedColumnFilterMessage; set => NotSupportedColumnFilterMessage = value; }
+
+    /// <summary>
+    /// 获得/设置 不支持过滤类型提示信息 默认 null 读取资源文件内容
+    /// </summary>
+    [Parameter]
+    public string? NotSupportedColumnFilterMessage { get; set; }
 
     /// <summary>
     /// 获得 相关联 ITableColumn 实例

src/BootstrapBlazor/Components/Table/Table.razor

@@ -586,7 +586,11 @@
                             }
                             @if (col.GetFilterable() && !ShowFilterHeader)
                             {
-                                <TableColumnFilter Icon="@FilterIcon" Column="col" Table="this" IsActive="@Filters.ContainsKey(fieldName)" @onclick:stopPropagation></TableColumnFilter>
+                                <TableColumnFilter Icon="@FilterIcon" Column="col" Table="this"
+                                                   IsActive="@Filters.ContainsKey(fieldName)"
+                                                   NotSupportedColumnFilterMessage="@NotSupportedColumnFilterMessage"
+                                                   @onclick:stopPropagation>
+                                </TableColumnFilter>
                             }
                             @if (col.GetSortable())
                             {
@@ -655,7 +659,9 @@
                         <div class="table-cell">
                             @if(col.GetFilterable())
                             {
-                                <TableColumnFilter Icon="@FilterIcon" Column="col" Table="this" IsHeaderRow="true"></TableColumnFilter>
+                                <TableColumnFilter Icon="@FilterIcon" Column="col" Table="this" IsHeaderRow="true"
+                                                   NotSupportedColumnFilterMessage="@NotSupportedColumnFilterMessage">
+                                </TableColumnFilter>
                             }
                         </div>
                     </th>

src/BootstrapBlazor/Components/Table/Table.razor.cs

@@ -16,6 +16,12 @@ namespace BootstrapBlazor.Components;
 [CascadingTypeParameter(nameof(TItem))]
 public partial class Table<TItem> : ITable, IModelEqualityComparer<TItem> where TItem : class
 {
+    /// <summary>
+    /// 获得/设置 不支持过滤类型提示信息 默认 null 读取资源文件内容
+    /// </summary>
+    [Parameter]
+    public string? NotSupportedColumnFilterMessage { get; set; }
+
     /// <summary>
     /// 获得/设置 Loading 模板
     /// </summary>

src/BootstrapBlazor/Locales/en.json

@@ -274,7 +274,7 @@
     "Contains": "Contains",
     "NotContains": "NotContains",
     "EnumFilter.AllText": "All",
-    "NotSupportedMessage": "Unsupported filter type, Please customize the filter use FilterTemplate",
+    "NotSupportedColumnFilterMessage": "<p>Unsupported filter type, Please customize the filter use <code>FilterTemplate</code></p><div>Please refer <a href=\"https://www.blazor.zone/table/filter#CustomFilter\" target=\"_blank\">CustomFilter</a></div>",
     "MultiFilterSearchPlaceHolderText": "Please enter ...",
     "MultiFilterSelectAllText": "Select All"
   },

src/BootstrapBlazor/Locales/zh.json

@@ -274,7 +274,7 @@
     "Contains": "包含",
     "NotContains": "不包含",
     "EnumFilter.AllText": "全选",
-    "NotSupportedMessage": "不支持的类型，请使用 FilterTemplate 自定义过滤组件",
+    "NotSupportedColumnFilterMessage": "<p>不支持的类型，请使用 <code>FilterTemplate</code> 自定义过滤组件</p><div>请参考文档 <a href=\"https://www.blazor.zone/table/filter#CustomFilter\" target=\"_blank\">CustomFilter</a></div>",
     "MultiFilterSearchPlaceHolderText": "请输入 ...",
     "MultiFilterSelectAllText": "全选"
   },

test/UnitTest/Components/TableNotSupportFilterTest.cs

@@ -12,11 +12,12 @@ public void OnFilterAsync_Ok()
     {
         var cut = Context.RenderComponent<TableColumnFilter>(pb =>
         {
+            pb.Add(a => a.NotSupportedColumnFilterMessage, "不支持的类型");
             pb.Add(a => a.Table, new MockTable());
             pb.Add(a => a.Column, new MockColumn());
         });
 
-        cut.Contains("不支持的类型，请使用 FilterTemplate 自定义过滤组件");
+        cut.Contains("不支持的类型");
 
         var filter = cut.FindComponent<NotSupportFilter>();
         var conditions = filter.Instance.GetFilterConditions();

test/UnitTest/Components/TableTest.cs

@@ -451,6 +451,7 @@ public async Task CustomSearch_Ok()
         {
             pb.AddChildContent<Table<Foo>>(pb =>
             {
+                pb.Add(a => a.NotSupportedColumnFilterMessage, "test-not-support");
                 pb.Add(a => a.SearchText, "张三");
                 pb.Add(a => a.TableColumns, foo => builder =>
                 {