Skip to content

feat(Input): use IsClearable instead of Clearable #5108

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
merged 3 commits into from
Jan 14, 2025
Merged

feat(Input): use IsClearable instead of Clearable #5108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
018faeb
refactor: 重构参数名称
ArgoZhang Jan 14, 2025
669e1c9
doc: 更新示例
ArgoZhang Jan 14, 2025
4897227
test: 更新单元测试
ArgoZhang Jan 14, 2025
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: 4 additions & 4 deletions src/BootstrapBlazor.Server/Components/Samples/Inputs.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,24 +227,24 @@
Name="OnInput">
<div class="row g-3">
<div class="col-12 col-sm-6">
<BootstrapInput Value="Model.Name" Clearable="true" ShowLabel="true" DisplayText="Clearable" />
<BootstrapInput Value="Model.Name" IsClearable="true" ShowLabel="true" DisplayText="Clearable" />
</div>
</div>
<div class="row form-inline g-3 mt-0">
<div class="col-12 col-sm-6">
<BootstrapInput Value="Model.Name" Clearable="true" ShowLabel="true" DisplayText="Clearable" />
<BootstrapInput Value="Model.Name" IsClearable="true" ShowLabel="true" DisplayText="Clearable" />
</div>
</div>
<div class="row g-3 mt-0">
<div class="col-12 col-sm-6">
<BootstrapInputGroup>
<BootstrapInputGroupLabel ShowRequiredMark DisplayText="Clearable"></BootstrapInputGroupLabel>
<BootstrapInput Value="@Model.Name" Clearable="true" />
<BootstrapInput Value="@Model.Name" IsClearable="true" />
</BootstrapInputGroup>
</div>
<div class="col-12 col-sm-6">
<BootstrapInputGroup>
<BootstrapInput Value="@Model.Name" Clearable="true" />
<BootstrapInput Value="@Model.Name" IsClearable="true" />
<BootstrapInputGroupLabel ShowRequiredMark DisplayText="Clearable"></BootstrapInputGroupLabel>
</BootstrapInputGroup>
</div>
Expand Down
2 changes: 1 addition & 1 deletion src/BootstrapBlazor/Components/Input/BootstrapInput.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<BootstrapLabel required="@Required" for="@Id" ShowLabelTooltip="ShowLabelTooltip" Value="@DisplayText" />
}

@if (Clearable)
@if (IsClearable)
{
<div class="bb-clearable-input">
@RenderInput
Expand Down
24 changes: 20 additions & 4 deletions src/BootstrapBlazor/Components/Input/BootstrapInput.razor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,15 @@ public partial class BootstrapInput<TValue>
/// 获得/设置 是否显示清空小按钮 默认 false
/// </summary>
[Parameter]
public bool Clearable { get; set; }
[Obsolete("已弃用，请使用 IsClearable 参数；Deprecated use the IsClearable parameter")]
[ExcludeFromCodeCoverage]
public bool Clearable { get => IsClearable; set => IsClearable = value; }

/// <summary>
/// 获得/设置 是否显示清空小按钮 默认 false
/// </summary>
[Parameter]
public bool IsClearable { get; set; }

/// <summary>
/// 获得/设置 清空文本框时回调方法 默认 null
Expand All @@ -38,7 +46,15 @@ public partial class BootstrapInput<TValue>
/// 获得/设置 清空小按钮图标 默认 null
/// </summary>
[Parameter]
public string? ClearableIcon { get; set; }
[Obsolete("已弃用，请使用 ClearIcon 参数；Deprecated use the ClearIcon parameter")]
[ExcludeFromCodeCoverage]
public string? ClearableIcon { get => ClearIcon; set => ClearIcon = value; }

/// <summary>
/// 获得/设置 清空小按钮图标 默认 null
/// </summary>
[Parameter]
public string? ClearIcon { get; set; }

/// <summary>
/// 图标主题服务
Expand All @@ -50,7 +66,7 @@ public partial class BootstrapInput<TValue>
private string? ReadonlyString => Readonly ? "true" : null;

private string? ClearableIconString => CssBuilder.Default("form-control-clear-icon")
.AddClass(ClearableIcon)
.AddClass(ClearIcon)
.Build();

/// <summary>
Expand All @@ -60,7 +76,7 @@ protected override void OnParametersSet()
{
base.OnParametersSet();

ClearableIcon ??= IconTheme.GetIconByKey(ComponentIcons.InputClearIcon);
ClearIcon ??= IconTheme.GetIconByKey(ComponentIcons.InputClearIcon);
}

/// <summary>
Expand Down
6 changes: 3 additions & 3 deletions test/UnitTest/Components/InputTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ public void Readonly_Ok()
[Fact]
public void Clearable_Ok()
{
var cut = Context.RenderComponent<BootstrapInput<string>>(builder => builder.Add(a => a.Clearable, false));
var cut = Context.RenderComponent<BootstrapInput<string>>(builder => builder.Add(a => a.IsClearable, false));
cut.DoesNotContain("bb-clearable-input");

cut.SetParametersAndRender(pb => pb.Add(a => a.Clearable, true));
cut.SetParametersAndRender(pb => pb.Add(a => a.IsClearable, true));
cut.Contains("bb-clearable-input");
cut.Contains("form-control-clear-icon");

Expand All @@ -93,7 +93,7 @@ public async Task OnClear_Ok()
var clicked = false;
var cut = Context.RenderComponent<BootstrapInput<string>>(builder =>
{
builder.Add(a => a.Clearable, true);
builder.Add(a => a.IsClearable, true);
builder.Add(a => a.OnClear, v =>
{
clicked = true;
Expand Down
Loading