feat(EditorForm): add IgnoreItems parameter (#7607)

ArgoZhang · web-flow · commit 48607cbef664 · 2026-01-31T10:10:27.000+08:00
* refactor: 代码重构提高可读性

* feat: 增加 IgnoreItems 属性

* feat: 增加忽略集合过滤逻辑

* doc: 更新示例

* chore: bump version 10.3.1-beta01

* test: 更新单元测试
diff --git a/src/BootstrapBlazor.Server/Components/Samples/EditorForms.razor b/src/BootstrapBlazor.Server/Components/Samples/EditorForms.razor
@@ -138,6 +138,17 @@
     </EditorForm>
 </DemoBlock>
 
+<DemoBlock Title="@Localizer["IgnoreItemsTitle"]" Introduction="@Localizer["IgnoreItemsIntro"]" Name="IgnoreItems">
+    <section ignore>
+        <div>@((MarkupString)Localizer["IgnoreItemsDescription"].Value)</div>
+        <Button OnClick="OnSwitchIgnoreItems" Text="@Localizer["IgnoreItemsSwitchButtonText"]" class="mt-3"></Button>
+    </section>
+    <GroupBox Title="@Localizer["GroupBoxTitle"]" style="margin-top: 1.5rem;">
+        <EditorForm Model="@Model" AutoGenerateAllItem="true" IgnoreItems="@_ignoreItems">
+        </EditorForm>
+    </GroupBox>
+</DemoBlock>
+
 <AttributeTable Type="typeof(EditorForm<>)" />
 
-<AttributeTable Title="@Localizer["EditorFormAttributeTitle"]" Type="typeof(EditorItem<,>)"></AttributeTable>
+<AttributeTable Type="typeof(EditorItem<,>)"></AttributeTable>
diff --git a/src/BootstrapBlazor.Server/Components/Samples/EditorForms.razor.cs b/src/BootstrapBlazor.Server/Components/Samples/EditorForms.razor.cs
@@ -1,4 +1,4 @@
-﻿// Licensed to the .NET Foundation under one or more agreements.
+// 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
@@ -25,6 +25,21 @@ public sealed partial class EditorForms
     [NotNull]
     private IStringLocalizer<Foo>? FooLocalizer { get; set; }
 
+    private List<string> _ignoreItems = [];
+
+    private Task OnSwitchIgnoreItems()
+    {
+        if (_ignoreItems.Count != 0)
+        {
+            _ignoreItems.Clear();
+        }
+        else
+        {
+            _ignoreItems = [nameof(Foo.Hobby)];
+        }
+        return Task.CompletedTask;
+    }
+
     private List<SelectedItem> DummyItems { get; } =
     [
         new SelectedItem("1", "1"),
diff --git a/src/BootstrapBlazor.Server/Locales/en-US.json b/src/BootstrapBlazor.Server/Locales/en-US.json
@@ -2128,7 +2128,6 @@
     "AutoGenerateIntro": "By setting the property <code>AutoGenerateAllItem</code> value of <code>false</code> the property is prohibited from being automatically generated, and the display property is controlled by setting the <code>FieldItems</code> internal collection",
     "AutoGenerateTitle": "It is not automatically generated by default",
     "Description": "Edit forms are automatically rendered through the bound data model",
-    "EditorFormAttributeTitle": "EditorItem Attribute",
     "EditorFormTips1": "The binding model automatically generates all properties by default, and you can change to not automatically build by setting <code>AutoGenerateAllItem</code>",
     "EditorFormTips2": "If you don't need to edit the columns, set the <code>Editable</code>, the default is <code>true</code> build editing components",
     "EditorFormTips3": "Complex edit columns, set up <code>EditTemplate</code> templates, and edit custom components",
@@ -2153,7 +2152,11 @@
     "ValidateFormIntro": "Data compliance checks are implemented through nested <code>ValidateForm</code> components",
     "ValidateFormTips1": "The component is built into the <code>ValidateForm</code> to turn on data compliance checks, and <b>hobby</b>fields use the <code>EditTemplate</code> template to customize the component to render the data",
     "ValidateFormTips2": "Make the <code>birthday</code> field read-only by setting the <code>Readonly</code> property",
-    "ValidateFormTitle": "Turn on data validation"
+    "ValidateFormTitle": "Turn on data validation",
+    "IgnoreItemsTitle": "IgnoreItems",
+    "IgnoreItemsIntro": "By setting the <code>IgnoreItems</code> value, you can notify the component not to render the specified column in the collection.",
+    "IgnoreItemsDescription": "This attribute has the same priority as `<editorItem>`, and if it is set to ignore anywhere else, it will not be rendered.",
+    "IgnoreItemsSwitchButtonText": "Switch"
   },
   "BootstrapBlazor.Server.Components.Samples.Editors": {
     "DoMethodAsyncButton1": "Insert Html",
diff --git a/src/BootstrapBlazor.Server/Locales/zh-CN.json b/src/BootstrapBlazor.Server/Locales/zh-CN.json
@@ -2128,7 +2128,6 @@
     "AutoGenerateIntro": "通过设置属性 <code>AutoGenerateAllItem</code> 值为 <code>false</code>，禁止自动生成属性，通过设置 <code>FieldItems</code> 内部集合来控制显示属性",
     "AutoGenerateTitle": "默认不自动生成",
     "Description": "通过绑定数据模型自动呈现编辑表单",
-    "EditorFormAttributeTitle": "EditorItem 属性",
     "EditorFormTips1": "绑定模型默认自动生成全部属性，可以通过设置 <code>AutoGenerateAllItem</code> 更改为不自动生成",
     "EditorFormTips2": "如不需要编辑列，设置 <code>Editable</code> 即可，默认值为 <code>true</code> 生成编辑组件",
     "EditorFormTips3": "复杂编辑列，设置 <code>EditTemplate</code> 模板，进行自定义组件进行编辑",
@@ -2153,7 +2152,11 @@
     "ValidateFormIntro": "通过嵌套 <code>ValidateForm</code> 组件实现数据合规检查功能",
     "ValidateFormTips1": "组件内置到 <code>ValidateForm</code> 内开启数据合规检查功能，<b>爱好</b> 字段使用 <code>EditTemplate</code> 模板自定义组件呈现数据",
     "ValidateFormTips2": "通过设置 <code>Readonly</code> 属性，使 <code>生日</code> 字段为只读",
-    "ValidateFormTitle": "开启数据验证"
+    "ValidateFormTitle": "开启数据验证",
+    "IgnoreItemsTitle": "IgnoreItems 忽略集合",
+    "IgnoreItemsIntro": "通过设置 <code>IgnoreItems</code> 值通知组件不渲染集合中的指定列",
+    "IgnoreItemsDescription": "此属性的优先级与在 <code>IEditorItem</code> 相同，任何一个地方设置了忽略，最终都不会渲染",
+    "IgnoreItemsSwitchButtonText": "切换"
   },
   "BootstrapBlazor.Server.Components.Samples.Editors": {
     "DoMethodAsyncButton1": "插入一段 Html",
diff --git a/src/BootstrapBlazor/BootstrapBlazor.csproj b/src/BootstrapBlazor/BootstrapBlazor.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk.Razor">
 
   <PropertyGroup>
-    <Version>10.3.0</Version>
+    <Version>10.3.1-beta01</Version>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/BootstrapBlazor/Components/EditorForm/EditorForm.razor.cs b/src/BootstrapBlazor/Components/EditorForm/EditorForm.razor.cs
@@ -149,6 +149,13 @@ public partial class EditorForm<TModel> : IShowLabel, IDisposable
     [Parameter]
     public bool AutoGenerateAllItem { get; set; } = true;
 
+    /// <summary>
+    /// <para lang="zh">获得/设置 忽略项目集合 默认 null 未设置</para>
+    /// <para lang="en">Gets or sets the ignore items collection. Default is null</para>
+    /// </summary>
+    [Parameter]
+    public List<string>? IgnoreItems { get; set; }
+
     /// <summary>
     /// <para lang="zh">获得/设置 级联上下文绑定字段信息集合 设置此参数后 <see cref="FieldItems"/> 模板不生效</para>
     /// <para lang="en">Gets or sets Context Field Items Collection. <see cref="FieldItems"/> template will not be effective if set</para>
@@ -279,49 +286,55 @@ private List<IEditorItem> GetRenderItems()
         var items = new List<IEditorItem>();
         if (Items != null)
         {
-            items.AddRange(Items.Where(i => !i.GetIgnore() && !string.IsNullOrEmpty(i.GetFieldName())));
+            items.AddRange(Items.Where(i => !i.GetIgnore() && !string.IsNullOrEmpty(i.GetFieldName()) && FilterIgnoreItem(i)));
+            return items;
         }
-        else
+
+        // 如果 EditorItems 有值表示 用户自定义列
+        // If EditorItems has value, it means user defined columns
+        var columns = AutoGenerateAllItem
+            ? AutoGenerateColumns()
+            : _editorItems.Where(i => !i.GetIgnore()
+                && !string.IsNullOrEmpty(i.GetFieldName())
+                && i.IsVisible(ItemChangedType, IsSearch.Value));
+        items.AddRange(columns.Where(i => FilterIgnoreItem(i)));
+        return items;
+    }
+
+    private bool FilterIgnoreItem(IEditorItem item)
+    {
+        return IgnoreItems?.Find(i => i.Equals(item.GetFieldName(), StringComparison.OrdinalIgnoreCase)) == null;
+    }
+
+    private List<ITableColumn> AutoGenerateColumns()
+    {
+        // 获取绑定模型所有属性
+        // Get all properties of binding model
+        var columns = Utility.GetTableColumns<TModel>(defaultOrderCallback: ColumnOrderCallback).ToList();
+
+        // 通过设定的 FieldItems 模板获取项进行渲染
+        // Render items by setting FieldItems template
+        foreach (var el in _editorItems)
         {
-            // 如果 EditorItems 有值表示 用户自定义列
-            // If EditorItems has value, it means user defined columns
-            if (AutoGenerateAllItem)
+            var item = columns.FirstOrDefault(i => i.GetFieldName() == el.GetFieldName());
+            if (item != null)
             {
-                // 获取绑定模型所有属性
-                // Get all properties of binding model
-                var columns = Utility.GetTableColumns<TModel>(defaultOrderCallback: ColumnOrderCallback).ToList();
-
-                // 通过设定的 FieldItems 模板获取项进行渲染
-                // Render items by setting FieldItems template
-                foreach (var el in _editorItems)
+                // 过滤掉不编辑与不可见的列
+                // Filter out non-editable and invisible columns
+                if (el.GetIgnore() || !el.IsVisible(ItemChangedType, IsSearch.Value) || string.IsNullOrEmpty(el.GetFieldName()))
                 {
-                    var item = columns.FirstOrDefault(i => i.GetFieldName() == el.GetFieldName());
-                    if (item != null)
-                    {
-                        // 过滤掉不编辑与不可见的列
-                        // Filter out non-editable and invisible columns
-                        if (el.GetIgnore() || !el.IsVisible(ItemChangedType, IsSearch.Value) || string.IsNullOrEmpty(el.GetFieldName()))
-                        {
-                            columns.Remove(item);
-                        }
-                        else
-                        {
-                            // 设置只读属性与列模板
-                            // Set Readonly property and column template
-                            item.CopyValue(el);
-                        }
-                    }
+                    columns.Remove(item);
+                }
+                else
+                {
+                    // 设置只读属性与列模板
+                    // Set Readonly property and column template
+                    item.CopyValue(el);
                 }
-                items.AddRange(columns);
-            }
-            else
-            {
-                items.AddRange(_editorItems.Where(i => !i.GetIgnore()
-                    && !string.IsNullOrEmpty(i.GetFieldName())
-                    && i.IsVisible(ItemChangedType, IsSearch.Value)));
             }
         }
-        return items;
+
+        return columns;
     }
 
     private RenderFragment AutoGenerateTemplate(IEditorItem item) => builder =>
diff --git a/test/UnitTest/Components/EditorFormTest.cs b/test/UnitTest/Components/EditorFormTest.cs
@@ -87,6 +87,26 @@ public void AutoGenerateAllItem_True(bool autoGenerate)
         });
     }
 
+    [Fact]
+    public void IgnoreItems_Ok()
+    {
+        var ignoreItems = new List<string> { nameof(Foo.Hobby) };
+        var foo = new Foo();
+        var cut = Context.Render<EditorForm<Foo>>(pb =>
+        {
+            pb.Add(a => a.AutoGenerateAllItem, true);
+            pb.Add(a => a.Model, foo);
+            pb.Add(a => a.IgnoreItems, ignoreItems);
+        });
+        cut.DoesNotContain("爱好");
+
+        cut.Render(pb =>
+        {
+            pb.Add(a => a.IgnoreItems, []);
+        });
+        cut.Contains("爱好");
+    }
+
     [Fact]
     public void IsDisplay_Ok()
     {
