Skip to content

Commit 8b00dd1

Browse files
authored
doc(Table): update documentation for Table search function (#7792)
* doc: 更新用法文档 * doc: 增加提示信息
1 parent 18bfd5a commit 8b00dd1

File tree

3 files changed

+15
-1
lines changed

3 files changed

+15
-1
lines changed

src/BootstrapBlazor.Server/Components/Samples/Table/TablesSearch.razor

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@
1616
Name="SearchForm">
1717
<section ignore>
1818
<p>@((MarkupString)Localizer["SearchFormDesc"].Value)</p>
19+
<ul class="ul-demo">
20+
<li>@((MarkupString)Localizer["SearchFormDescItem1"].Value)</li>
21+
<li>@((MarkupString)Localizer["SearchFormDescItem2"].Value)</li>
22+
</ul>
1923
<div>@((MarkupString)Localizer["SearchFormTips"].Value)</div>
2024
</section>
2125
<Table TItem="Foo"
@@ -82,6 +86,10 @@
8286
</Table>
8387
</DemoBlock>
8488

89+
<Tips class="mt-3">
90+
<div>@((MarkupString)Localizer["SearchFormWarningTips"].Value)</div>
91+
</Tips>
92+
8593
<DemoBlock Title="@Localizer["SearchTableTitle"]"
8694
Introduction="@Localizer["SearchTableIntro"]"
8795
Name="SearchTable">

src/BootstrapBlazor.Server/Locales/en-US.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5065,9 +5065,12 @@
50655065
"EditModelTitle": "Edit Test Data Window",
50665066
"NamePlaceholder": "Please enter your name within 50 characters",
50675067
"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>",
5068+
"SearchFormDescItem1": "Customize metadata using the <code>SearchFormItemMetadata</code> property in <code>TableColumn</code>.",
5069+
"SearchFormDescItem2": "Customize the search item UI using the <code>RenderContent</code> method in the <code>SearchFormItemMetadata</code> parameter.",
50685070
"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",
50695071
"SearchFormTips": "Enabling <code>UseSearchForm</code> will prevent <code>SearchModel</code> <code>SearchTemplate</code>, <code>CustomerSearchModel</code>, and <code>CustomerSearchTemplate</code> from taking effect.",
50705072
"SearchFormTitle": "Search Form",
5073+
"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>.",
50715074
"SearchTableGroupBoxText": "Search Criteria",
50725075
"SearchTableIntro": "Set <code>ShowSearch</code> to display the query component, customize the search UI by setting the <code>SearchTemplate</code> template",
50735076
"SearchTableLi1": "Enable no data display function by setting <code>ShowEmpty=\"true\"</code>",

src/BootstrapBlazor.Server/Locales/zh-CN.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5064,10 +5064,13 @@
50645064
"DisplayText5": "搜索表单",
50655065
"EditModelTitle": "编辑测试数据窗口",
50665066
"NamePlaceholder": "请输入姓名,50字以内",
5067-
"SearchFormDesc": "使用 <code>UseSearchForm</code> 开启搜索表单时未提供 <code>SearchItems</code> 默认尝试使用设置 <code>Searchable=\"true\"</code> 的 <code>TableColumn</code> 进行构建,可以通过 <code>TableColumn</code> 中的 <code>SearchFormItemMetadata</code> 属性定制化元数据",
5067+
"SearchFormDesc": "使用 <code>UseSearchForm</code> 开启搜索表单时未提供 <code>SearchItems</code> 默认尝试使用设置 <code>Searchable=\"true\"</code> 的 <code>TableColumn</code> 进行构建",
5068+
"SearchFormDescItem1": "通过 <code>TableColumn</code> 中的 <code>SearchFormItemMetadata</code> 属性定制化元数据",
5069+
"SearchFormDescItem2": "通过 <code>SearchFormItemMetadata</code> 参数中 <code>RenderContent</code> 方法自定义搜索项 UI",
50685070
"SearchFormIntro": "通过设置 <code>UseSearchForm=\"true\"</code> 开启搜索表单功能,通过 <code>SearchItems</code> 配置搜索表单内搜索项,适用于自定义复杂搜索条件的场景",
50695071
"SearchFormTips": "开启 <code>UseSearchForm</code> 后 <code>SearchModel</code> <code>SearchTemplate</code> <code>CustomerSearchModel</code> <code>CustomerSearchTemplate</code> 均不生效",
50705072
"SearchFormTitle": "搜索表单",
5073+
"SearchFormWarningTips": "<code>BootstrapBlazor</code> v10.4.2 版本后增加 <code>UseSearchForm</code> 参数后以下示例均可以不学习了,强烈推荐使用 <code>UseSearchForm</code>",
50715074
"SearchTableGroupBoxText": "搜索条件",
50725075
"SearchTableIntro": "设置 <code>ShowSearch</code> 显示查询组件,通过设置 <code>SearchTemplate</code> 模板自定义搜索 UI",
50735076
"SearchTableLi1": "通过设置 <code>ShowEmpty=\"true\"</code> 开启无数据显示功能",

0 commit comments

Comments
 (0)