Skip to content

Commit e713719

Browse files
authored
refactor(Select): remove IsFixedSearch parameter (#5660)
* refactor: 移除 IsFixedSearch 参数 # Conflicts: # src/BootstrapBlazor/Components/Select/SelectBase.cs * test: 更新单元测试 * doc: 更新默认值 * refactor: 移除 IsFixedSearch 参数 * refactor: 标注已弃用 * test: 更新单元测试 * doc: 更新示例 * doc: 更新文档注释
1 parent 2c5f7e4 commit e713719

31 files changed

+53
-191
lines changed

src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -117,12 +117,6 @@ private enum MultiSelectEnumFoo
117117
<section ignore>
118118
<p>@((MarkupString)Localizer["MultiSelectSearchDescription"].Value)</p>
119119
<div class="row g-3">
120-
<div class="col-12 col-sm-6">
121-
<BootstrapInputGroup>
122-
<BootstrapInputGroupLabel DisplayText="IsFixedSearch" />
123-
<Checkbox @bind-Value="@_isFixedSearch" />
124-
</BootstrapInputGroup>
125-
</div>
126120
<div class="col-12 col-sm-6">
127121
<BootstrapInputGroup>
128122
<BootstrapInputGroupLabel DisplayText="IsClearable" />
@@ -135,12 +129,12 @@ private enum MultiSelectEnumFoo
135129
<div class="row g-3">
136130
<div class="col-12 col-sm-6">
137131
<MultiSelect Items="@Items" @bind-Value="@SelectedSearchItemsValue"
138-
ShowSearch="true" IsFixedSearch="_isFixedSearch" IsClearable="_isClearable" OnSearchTextChanged="@OnSearch">
132+
ShowSearch="true" IsClearable="_isClearable" OnSearchTextChanged="@OnSearch">
139133
</MultiSelect>
140134
</div>
141135
<div class="col-12 col-sm-6">
142136
<MultiSelect Items="@LongItems" @bind-Value="@SelectedMaxItemsValue"
143-
ShowSearch="true" IsFixedSearch="_isFixedSearch" IsClearable="_isClearable">
137+
ShowSearch="true" IsClearable="_isClearable">
144138
</MultiSelect>
145139
</div>
146140
</div>
@@ -313,12 +307,6 @@ private enum MultiSelectEnumFoo
313307
<Checkbox @bind-Value="@_showSearch" />
314308
</BootstrapInputGroup>
315309
</div>
316-
<div class="col-12 col-sm-6">
317-
<BootstrapInputGroup>
318-
<BootstrapInputGroupLabel DisplayText="IsFixedSearch" />
319-
<Checkbox @bind-Value="@_isFixedSearch" />
320-
</BootstrapInputGroup>
321-
</div>
322310
<div class="col-12 col-sm-6">
323311
<BootstrapInputGroup>
324312
<BootstrapInputGroupLabel DisplayText="ShowToolbar" />
@@ -339,7 +327,7 @@ private enum MultiSelectEnumFoo
339327
<div class="col-6">
340328
<MultiSelect IsVirtualize="true" @bind-Value="_virtualItemString1" OnQueryAsync="OnQueryAsync"
341329
ShowSearch="_showSearch" ShowToolbar="_showToolbar"
342-
IsFixedSearch="_isFixedSearch" IsClearable="_isClearable">
330+
IsClearable="_isClearable">
343331
</MultiSelect>
344332
</div>
345333
<div class="col-6">
@@ -352,7 +340,7 @@ private enum MultiSelectEnumFoo
352340
<div class="col-6">
353341
<MultiSelect IsVirtualize="true" @bind-Value="_virtualItemString2" Items="VirtualItems"
354342
ShowSearch="_showSearch" ShowToolbar="_showToolbar"
355-
IsFixedSearch="_isFixedSearch" IsClearable="_isClearable">
343+
IsClearable="_isClearable">
356344
</MultiSelect>
357345
</div>
358346
<div class="col-6">

src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor.cs

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,6 @@ private enum MultiSelectEnumFoo
120120
private IEnumerable<SelectedItem> VirtualItems => Foos.Select(i => new SelectedItem(i.Name!, i.Name!)).ToList();
121121

122122
private string? _editString;
123-
124-
private bool _isFixedSearch = true;
125123
private bool _isClearable = true;
126124
private bool _showToolbar = true;
127125
private bool _showSearch = true;
@@ -382,14 +380,6 @@ private AttributeItem[] GetAttributes() =>
382380
DefaultValue = "false"
383381
},
384382
new()
385-
{
386-
Name = "IsFixedSearch",
387-
Description = Localizer["MultiSelectsAttribute_IsFixedSearch"],
388-
Type = "bool",
389-
ValueList = "true|false",
390-
DefaultValue = "false"
391-
},
392-
new()
393383
{
394384
Name = "ShowToolbar",
395385
Description = Localizer["MultiSelectsAttribute_ShowToolbar"],

src/BootstrapBlazor.Server/Components/Samples/Selects.razor

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -323,23 +323,17 @@
323323
<Checkbox @bind-Value="@_isShowSearchClearable" />
324324
</BootstrapInputGroup>
325325
</div>
326-
<div class="col-12 col-sm-6">
327-
<BootstrapInputGroup>
328-
<BootstrapInputGroupLabel DisplayText="IsFixedSearch" />
329-
<Checkbox @bind-Value="@_isFixedSearch" />
330-
</BootstrapInputGroup>
331-
</div>
332326
</div>
333327
</section>
334328
<div class="row g-3">
335329
<div class="col-12 col-sm-6">
336330
<Select TValue="string" Items="Items" ShowSearch="true"
337-
IsClearable="_isShowSearchClearable" IsFixedSearch="_isFixedSearch">
331+
IsClearable="_isShowSearchClearable">
338332
</Select>
339333
</div>
340334
<div class="col-12 col-sm-6">
341335
<Select TValue="string" Items="StringItems" ShowSearch="true"
342-
IsClearable="_isShowSearchClearable" IsFixedSearch="_isFixedSearch">
336+
IsClearable="_isShowSearchClearable">
343337
</Select>
344338
</div>
345339
</div>
@@ -440,12 +434,6 @@
440434
<Checkbox @bind-Value="@_showSearch" />
441435
</BootstrapInputGroup>
442436
</div>
443-
<div class="col-12 col-sm-6">
444-
<BootstrapInputGroup>
445-
<BootstrapInputGroupLabel DisplayText="IsFixedSearch" />
446-
<Checkbox @bind-Value="@_isFixedSearch" />
447-
</BootstrapInputGroup>
448-
</div>
449437
<div class="col-12 col-sm-6">
450438
<BootstrapInputGroup>
451439
<BootstrapInputGroupLabel DisplayText="IsClearable" />
@@ -459,7 +447,7 @@
459447
<div class="row mb-3">
460448
<div class="col-6">
461449
<Select IsVirtualize="true" OnQueryAsync="OnQueryAsync" @bind-Value="VirtualItem1"
462-
ShowSearch="_showSearch" IsFixedSearch="_isFixedSearch" IsClearable="_isClearable"></Select>
450+
ShowSearch="_showSearch" IsClearable="_isClearable"></Select>
463451
</div>
464452
<div class="col-6">
465453
<Display TValue="string" Value="@VirtualItem1?.Text"></Display>
@@ -470,7 +458,7 @@
470458
<div class="row">
471459
<div class="col-6">
472460
<Select IsVirtualize="true" Items="VirtualItems" @bind-Value="VirtualItem2"
473-
ShowSearch="_showSearch" IsFixedSearch="_isFixedSearch" IsClearable="_isClearable"></Select>
461+
ShowSearch="_showSearch" IsClearable="_isClearable"></Select>
474462
</div>
475463
<div class="col-6">
476464
<Display TValue="string" Value="@VirtualItem2?.Text"></Display>

src/BootstrapBlazor.Server/Components/Samples/Selects.razor.cs

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,10 @@ public sealed partial class Selects
4141
[NotNull]
4242
private IStringLocalizer<Foo>? LocalizerFoo { get; set; }
4343

44-
private bool _showSearch;
45-
44+
private bool _showSearch = true;
4645
private bool _showPopoverSearch = true;
47-
48-
private bool _isShowSearchClearable;
49-
50-
private bool _isFixedSearch;
51-
52-
private bool _isClearable;
53-
46+
private bool _isShowSearchClearable = true;
47+
private bool _isClearable = true;
5448
private string? _fooName;
5549

5650
private readonly List<SelectedItem> _enumValueDemoItems = [
@@ -359,14 +353,6 @@ private AttributeItem[] GetAttributes() =>
359353
DefaultValue = "false"
360354
},
361355
new()
362-
{
363-
Name = "IsFixedSearch",
364-
Description = Localizer["SelectsIsFixedSearch"],
365-
Type = "boolean",
366-
ValueList = "true / false",
367-
DefaultValue = "false"
368-
},
369-
new()
370356
{
371357
Name = "IsDisabled",
372358
Description = Localizer["SelectsIsDisabled"],

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3028,8 +3028,7 @@
30283028
"MultiSelectVirtualizeTitle": "Virtualize",
30293029
"MultiSelectVirtualizeIntro": "Set <code>IsVirtualize</code> to <b>true</b> enable virtual scroll for large data",
30303030
"MultiSelectVirtualizeDescription": "Component virtual scrolling supports two ways of providing data through <code>Items</code> or <code>OnQueryAsync</code> callback methods",
3031-
"MultiSelectsAttribute_ShowSearch": "Whether to display the search box",
3032-
"MultiSelectsAttribute_IsFixedSearch": "Whether fixed the search box"
3031+
"MultiSelectsAttribute_ShowSearch": "Whether to display the search box"
30333032
},
30343033
"BootstrapBlazor.Server.Components.Samples.Radios": {
30353034
"RadiosTitle": "Radio",
@@ -3205,8 +3204,7 @@
32053204
"SelectsGenericDesc": "<p>Please refer to <a href=\"https://github.com/dotnetcore/BootstrapBlazor/issues/4497?wt.mc_id=DT-MVP-5004174\" target=\"_blank\">Design Ideas</a> to understand this feature. In this example, by selecting the drop-down box option, the value obtained is the <code>Foo</code> instance, and the value displayed in the text box on the right is the <code>Address</code> value of the <code>Foo</code> attribute</p><p>In this example, the <code>ValueEqualityComparer</code> and <code>CustomKeyAttribute</code> parameters are not set, and the <code>[Key]</code> tag of the <code>Id</code> attribute of <code>Foo</code> is used for equality judgment</p>",
32063205
"SelectsOnInputChangedCallback": "Callback method for converting input text into corresponding Value in edit mode",
32073206
"TextConvertToValueCallback": "Callback method when input text changes in edit mode",
3208-
"SelectsIsEditable": "Whether editable",
3209-
"SelectsIsFixedSearch": "Whether fixed the search box"
3207+
"SelectsIsEditable": "Whether editable"
32103208
},
32113209
"BootstrapBlazor.Server.Components.Samples.Sliders": {
32123210
"SlidersTitle": "Slider",

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3028,8 +3028,7 @@
30283028
"MultiSelectVirtualizeTitle": "虚拟滚动",
30293029
"MultiSelectVirtualizeIntro": "通过设置 <code>IsVirtualize</code> 参数开启组件虚拟功能特性",
30303030
"MultiSelectVirtualizeDescription": "组件虚拟滚动支持两种形式通过 <code>Items</code> 或者 <code>OnQueryAsync</code> 回调方法提供数据",
3031-
"MultiSelectsAttribute_ShowSearch": "是否显示搜索框",
3032-
"MultiSelectsAttribute_IsFixedSearch": "是否固定搜索栏"
3031+
"MultiSelectsAttribute_ShowSearch": "是否显示搜索框"
30333032
},
30343033
"BootstrapBlazor.Server.Components.Samples.Radios": {
30353034
"RadiosTitle": "Radio 单选框",
@@ -3205,8 +3204,7 @@
32053204
"SelectsGenericDesc": "<p>请参考 <a href=\"https://github.com/dotnetcore/BootstrapBlazor/issues/4497?wt.mc_id=DT-MVP-5004174\" target=\"_blank\">设计思路</a> 理解此功能。本例中通过选择下拉框选项,得到的值为 <code>Foo</code> 实例,右侧文本框内显示值为 <code>Foo</code> 属性 <code>Address</code> 值</p><p>本例中未设置 <code>ValueEqualityComparer</code> 以及 <code>CustomKeyAttribute</code> 参数,使用 <code>Foo</code> 属性 <code>Id</code> 的 <code>[Key]</code> 标签进行相等判定</p>",
32063205
"SelectsOnInputChangedCallback": "编辑模式下输入文本转换为对应 Value 回调方法",
32073206
"TextConvertToValueCallback": "编辑模式下输入文本变化时回调方法",
3208-
"SelectsIsEditable": "是否可编辑",
3209-
"SelectsIsFixedSearch": "是否固定搜索栏"
3207+
"SelectsIsEditable": "是否可编辑"
32103208
},
32113209
"BootstrapBlazor.Server.Components.Samples.Sliders": {
32123210
"SlidersTitle": "Slider 滑块",

src/BootstrapBlazor/Attributes/AutoGenerateColumnAttribute.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,8 @@ public class AutoGenerateColumnAttribute : AutoGenerateBaseAttribute, ITableColu
233233
/// <summary>
234234
/// <inheritdoc/>
235235
/// </summary>
236+
[Obsolete("已弃用,请删除;Deprecated, please delete")]
237+
[ExcludeFromCodeCoverage]
236238
public bool IsFixedSearchWhenSelect { get; set; }
237239

238240
/// <summary>

src/BootstrapBlazor/Components/EditorForm/EditorItem.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,8 @@ public class EditorItem<TModel, TValue> : ComponentBase, IEditorItem
165165
/// <inheritdoc/>
166166
/// </summary>
167167
[Parameter]
168+
[Obsolete("已弃用,请删除;Deprecated, please delete")]
169+
[ExcludeFromCodeCoverage]
168170
public bool IsFixedSearchWhenSelect { get; set; }
169171

170172
/// <summary>

src/BootstrapBlazor/Components/EditorForm/IEditorItem.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ public interface IEditorItem : ILookup
8989
/// <summary>
9090
/// Gets or sets whether to allow fixed search box within dropdown. Default is false.
9191
/// </summary>
92+
[Obsolete("已弃用,请删除;Deprecated, please delete")]
93+
[ExcludeFromCodeCoverage]
9294
bool IsFixedSearchWhenSelect { get; set; }
9395

9496
/// <summary>

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ public partial class LookupFilter : ILookup
6262
/// 获得 是否为 ShowSearch 呈现模式 默认为 false
6363
/// </summary>
6464
[Parameter]
65+
[ExcludeFromCodeCoverage]
66+
[Obsolete("已弃用,请删除;Deprecated, please delete")]
6567
public bool IsFixedSearch { get; set; }
6668

6769
[Inject]

0 commit comments

Comments
 (0)