Skip to content

doc(Table): update documentation for Table search function #7792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ArgoZhang merged 2 commits into from
Mar 24, 2026
Merged

doc(Table): update documentation for Table search function #7792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb97eae
doc: 更新用法文档
ArgoZhang Mar 23, 2026
ebd87b8
doc: 增加提示信息
ArgoZhang Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/BootstrapBlazor.Server/Components/Samples/Table/TablesSearch.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@
Name="SearchForm">
<section ignore>
<p>@((MarkupString)Localizer["SearchFormDesc"].Value)</p>
<ul class="ul-demo">
<li>@((MarkupString)Localizer["SearchFormDescItem1"].Value)</li>
<li>@((MarkupString)Localizer["SearchFormDescItem2"].Value)</li>
</ul>
<div>@((MarkupString)Localizer["SearchFormTips"].Value)</div>
</section>
<Table TItem="Foo"
Expand Down Expand Up @@ -82,6 +86,10 @@
</Table>
</DemoBlock>

<Tips class="mt-3">
<div>@((MarkupString)Localizer["SearchFormWarningTips"].Value)</div>
</Tips>

<DemoBlock Title="@Localizer["SearchTableTitle"]"
Introduction="@Localizer["SearchTableIntro"]"
Name="SearchTable">
Expand Down
3 changes: 3 additions & 0 deletions src/BootstrapBlazor.Server/Locales/en-US.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5065,9 +5065,12 @@
"EditModelTitle": "Edit Test Data Window",
"NamePlaceholder": "Please enter your name within 50 characters",
"SearchFormDesc": "When <code>UseSearchForm</code> is enabled and <code>SearchItems</code> is not provided, it will default to using <code>TableColumn</code> with <code>Searchable=\"true\"</code>. You can customize the metadata through the <code>SearchFormItemMetadata</code> property in <code>TableColumn</code>",
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SearchFormDesc still contains the “customize metadata … SearchFormItemMetadata” sentence, but that same information is now repeated in the new bullet item SearchFormDescItem1. This makes the English docs redundant and inconsistent with zh-CN (which moved the customization details into list items). Consider shortening SearchFormDesc to only explain the default behavior, and keep customization guidance exclusively in the list items.

Suggested change
"SearchFormDesc": "When <code>UseSearchForm</code> is enabled and <code>SearchItems</code> is not provided, it will default to using <code>TableColumn</code> with <code>Searchable=\"true\"</code>. You can customize the metadata through the <code>SearchFormItemMetadata</code> property in <code>TableColumn</code>",
"SearchFormDesc": "When <code>UseSearchForm</code> is enabled and <code>SearchItems</code> is not provided, it will default to using <code>TableColumn</code> with <code>Searchable=\"true\"</code>.",

Copilot uses AI. Check for mistakes.
"SearchFormDescItem1": "Customize metadata using the <code>SearchFormItemMetadata</code> property in <code>TableColumn</code>.",
"SearchFormDescItem2": "Customize the search item UI using the <code>RenderContent</code> method in the <code>SearchFormItemMetadata</code> parameter.",
"SearchFormIntro": "Enable the search form feature by setting <code>UseSearchForm=\"true\"</code>, and configure the search items within the form using <code>SearchItems</code>, suitable for scenarios with custom complex search conditions",
"SearchFormTips": "Enabling <code>UseSearchForm</code> will prevent <code>SearchModel</code> <code>SearchTemplate</code>, <code>CustomerSearchModel</code>, and <code>CustomerSearchTemplate</code> from taking effect.",
"SearchFormTitle": "Search Form",
"SearchFormWarningTips": "<code>BootstrapBlazor</code> v10.4.2 introduced the <code>UseSearchForm</code> parameter, making the following examples obsolete. It is strongly recommended to use <code>UseSearchForm</code>.",
"SearchTableGroupBoxText": "Search Criteria",
"SearchTableIntro": "Set <code>ShowSearch</code> to display the query component, customize the search UI by setting the <code>SearchTemplate</code> template",
"SearchTableLi1": "Enable no data display function by setting <code>ShowEmpty=\"true\"</code>",
Expand Down
5 changes: 4 additions & 1 deletion src/BootstrapBlazor.Server/Locales/zh-CN.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5064,10 +5064,13 @@
"DisplayText5": "搜索表单",
"EditModelTitle": "编辑测试数据窗口",
"NamePlaceholder": "请输入姓名，50字以内",
"SearchFormDesc": "使用 <code>UseSearchForm</code> 开启搜索表单时未提供 <code>SearchItems</code> 默认尝试使用设置 <code>Searchable=\"true\"</code> 的 <code>TableColumn</code> 进行构建，可以通过 <code>TableColumn</code> 中的 <code>SearchFormItemMetadata</code> 属性定制化元数据",
"SearchFormDesc": "使用 <code>UseSearchForm</code> 开启搜索表单时未提供 <code>SearchItems</code> 默认尝试使用设置 <code>Searchable=\"true\"</code> 的 <code>TableColumn</code> 进行构建",
"SearchFormDescItem1": "通过 <code>TableColumn</code> 中的 <code>SearchFormItemMetadata</code> 属性定制化元数据",
"SearchFormDescItem2": "通过 <code>SearchFormItemMetadata</code> 参数中 <code>RenderContent</code> 方法自定义搜索项 UI",
"SearchFormIntro": "通过设置 <code>UseSearchForm=\"true\"</code> 开启搜索表单功能，通过 <code>SearchItems</code> 配置搜索表单内搜索项，适用于自定义复杂搜索条件的场景",
"SearchFormTips": "开启 <code>UseSearchForm</code> 后 <code>SearchModel</code> <code>SearchTemplate</code> <code>CustomerSearchModel</code> <code>CustomerSearchTemplate</code> 均不生效",
"SearchFormTitle": "搜索表单",
"SearchFormWarningTips": "<code>BootstrapBlazor</code> v10.4.2 版本后增加 <code>UseSearchForm</code> 参数后以下示例均可以不学习了，强烈推荐使用 <code>UseSearchForm</code>",
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The zh-CN text for SearchFormWarningTips has a grammatical duplication (“版本后增加 … 参数后 …”), and the wording “不学习了” is ambiguous/colloquial for documentation. Consider rephrasing to remove the duplicated “后” and use clearer wording (e.g., “自 v10.4.2 起新增…，以下示例可作为旧方案参考/可忽略…”) while keeping the intended meaning.

Suggested change
"SearchFormWarningTips": "<code>BootstrapBlazor</code> v10.4.2 版本后增加 <code>UseSearchForm</code> 参数后以下示例均可以不学习了，强烈推荐使用 <code>UseSearchForm</code>",
"SearchFormWarningTips": "自 <code>BootstrapBlazor</code> v10.4.2 起新增 <code>UseSearchForm</code> 参数，以下示例可作为旧方案参考，推荐优先使用 <code>UseSearchForm</code>",

Copilot uses AI. Check for mistakes.
"SearchTableGroupBoxText": "搜索条件",
"SearchTableIntro": "设置 <code>ShowSearch</code> 显示查询组件，通过设置 <code>SearchTemplate</code> 模板自定义搜索 UI",
"SearchTableLi1": "通过设置 <code>ShowEmpty=\"true\"</code> 开启无数据显示功能",
Expand Down
Loading