Skip to content

Commit db68c03

Browse files
ArgoZhangArgoZhang
committed
Merge branch 'master' into doc-xml
2 parents 369f8b4 + 53cc3e6 commit db68c03

10 files changed

Lines changed: 99 additions & 49 deletions

File tree

‎src/components/BootstrapBlazor.Region/BootstrapBlazor.Region.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<Project Sdk="Microsoft.NET.Sdk.Razor">
22

33
<PropertyGroup>
4-
<Version>10.0.1</Version>
4+
<Version>10.0.2</Version>
55
</PropertyGroup>
66

77
<PropertyGroup>

‎src/components/BootstrapBlazor.Region/Components/SelectCity.razor.cs‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,35 @@
77
namespace BootstrapBlazor.Components;
88

99
/// <summary>
10-
/// SelectCity 组件
10+
/// <para lang="zh">SelectCity 组件</para>
11+
/// <para lang="en">SelectCity component</para>
1112
/// </summary>
1213
public partial class SelectCity
1314
{
1415
/// <summary>
15-
/// 获得/设置 是否可多选 默认 false 单选
16+
/// <para lang="zh">获得/设置 是否可多选，默认 false 单选</para>
17+
/// <para lang="en">Gets or sets whether multiple selection is enabled. Default is false (single selection)</para>
1618
/// </summary>
1719
[Parameter]
1820
public bool IsMultiple { get; set; }
1921

2022
/// <summary>
21-
/// 获得/设置 是否开启搜索功能 默认 true 开启
23+
/// <para lang="zh">获得/设置 是否开启搜索功能，默认 true 开启</para>
24+
/// <para lang="en">Gets or sets whether search is enabled. Default is true</para>
2225
/// </summary>
2326
[Parameter]
2427
public bool ShowSearch { get; set; } = true;
2528

2629
/// <summary>
27-
/// Gets or sets the search icon.
30+
/// <para lang="zh">获得/设置 搜索图标</para>
31+
/// <para lang="en">Gets or sets the search icon</para>
2832
/// </summary>
2933
[Parameter]
3034
public string? SearchIcon { get; set; }
3135

3236
/// <summary>
33-
/// 获得/设置 单选时选择后是否自动关闭 默认 true
34-
/// <para><see cref="IsMultiple"/> 值为 true 时，这个参数不生效</para>
37+
/// <para lang="zh">获得/设置 单选时选择后是否自动关闭，默认 true <see cref="IsMultiple"/> 值为 true 时，这个参数不生效</para>
38+
/// <para lang="en">Gets or sets whether to automatically close after selection when single selection is enabled. Default is true. This parameter does not take effect when <see cref="IsMultiple"/> is true</para>
3539
/// </summary>
3640
[Parameter]
3741
public bool AutoClose { get; set; } = true;
@@ -87,7 +91,6 @@ protected override void OnParametersSet()
8791
/// <inheritdoc/>
8892
/// </summary>
8993
/// <param name="firstRender"></param>
90-
/// <returns></returns>
9194
protected override async Task OnAfterRenderAsync(bool firstRender)
9295
{
9396
await base.OnAfterRenderAsync(firstRender);
@@ -107,17 +110,16 @@ protected override async Task OnAfterRenderAsync(bool firstRender)
107110
/// <summary>
108111
/// <inheritdoc/>
109112
/// </summary>
110-
/// <returns></returns>
111113
protected override Task InvokeInitAsync() => InvokeVoidAsync("init", Id, Interop, new
112114
{
113115
TriggerSearch = nameof(TriggerSearch)
114116
});
115117

116118
/// <summary>
117-
/// 触发过滤方法 由 JavaScript 触发
119+
/// <para lang="zh">触发过滤方法，由 JavaScript 触发</para>
120+
/// <para lang="en">Trigger filter method, invoked by JavaScript</para>
118121
/// </summary>
119122
/// <param name="v"></param>
120-
/// <returns></returns>
121123
[JSInvokable]
122124
public void TriggerSearch(string v)
123125
{

‎src/components/BootstrapBlazor.Region/Components/SelectProvince.razor.cs‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
1+
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33
// Website: https://www.blazor.zone or https://argozhang.github.io/
44

55
namespace BootstrapBlazor.Components;
66

77
/// <summary>
8-
/// SelectProvince 组件
8+
/// <para lang="zh">SelectProvince 组件</para>
9+
/// <para lang="en">SelectProvince component</para>
910
/// </summary>
1011
public partial class SelectProvince
1112
{
1213
/// <summary>
13-
/// 获得/设置 是否可多选 默认 false 单选
14+
/// <para lang="zh">获得/设置 是否可多选，默认 false 单选</para>
15+
/// <para lang="en">Gets or sets whether multiple selection is enabled. Default is false (single selection)</para>
1416
/// </summary>
1517
[Parameter]
1618
public bool IsMultiple { get; set; }

‎src/components/BootstrapBlazor.Region/Components/SelectRegion.razor.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
1+
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33
// Website: https://www.blazor.zone or https://argozhang.github.io/
44

55
namespace BootstrapBlazor.Components;
66

77
/// <summary>
8-
/// SelectRegion 组件
8+
/// <para lang="zh">SelectRegion 组件</para>
9+
/// <para lang="en">SelectRegion component</para>
910
/// </summary>
1011
public partial class SelectRegion
1112
{

‎src/components/BootstrapBlazor.Region/Components/SelectRegionBase.cs‎

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,71 @@
1-
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
1+
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33
// Website: https://www.blazor.zone or https://argozhang.github.io/
44

55
namespace BootstrapBlazor.Components;
66

77
/// <summary>
8-
/// SelectRegion 组件基类
8+
/// <para lang="zh">SelectRegion 组件基类</para>
9+
/// <para lang="en">SelectRegion component base class</para>
910
/// </summary>
1011
public abstract class SelectRegionBase : PopoverSelectBase<string>
1112
{
1213
/// <summary>
13-
/// Gets or sets the placeholder text.
14+
/// <para lang="zh">获得/设置 占位符文本</para>
15+
/// <para lang="en">Gets or sets the placeholder text</para>
1416
/// </summary>
1517
[Parameter]
1618
public string? PlaceHolder { get; set; }
1719

1820
/// <summary>
19-
/// Gets or sets the color. The default is <see cref="Color.None"/> (no color).
21+
/// <para lang="zh">获得/设置 颜色，默认为 <see cref="Color.None"/>（无颜色）</para>
22+
/// <para lang="en">Gets or sets the color. The default is <see cref="Color.None"/> (no color)</para>
2023
/// </summary>
2124
[Parameter]
2225
public Color Color { get; set; }
2326

2427
/// <summary>
25-
/// Gets or sets the dropdown icon. The default is "fa-solid fa-angle-up".
28+
/// <para lang="zh">获得/设置 下拉图标，默认为 fa-solid fa-angle-up</para>
29+
/// <para lang="en">Gets or sets the dropdown icon. The default is "fa-solid fa-angle-up"</para>
2630
/// </summary>
2731
[Parameter]
2832
[NotNull]
2933
public string? DropdownIcon { get; set; }
3034

3135
/// <summary>
32-
/// Gets or sets the callback method when the clear button is clicked. Default is null.
36+
/// <para lang="zh">获得/设置 点击清空按钮时的回调方法，默认为 null</para>
37+
/// <para lang="en">Gets or sets the callback method when the clear button is clicked. Default is null</para>
3338
/// </summary>
3439
[Parameter]
3540
public Func<Task>? OnClearAsync { get; set; }
3641

3742
/// <summary>
38-
/// Gets or sets the right-side clear icon. Default is fa-solid fa-angle-up.
43+
/// <para lang="zh">获得/设置 右侧清空图标，默认为 fa-solid fa-angle-up</para>
44+
/// <para lang="en">Gets or sets the right-side clear icon. Default is fa-solid fa-angle-up</para>
3945
/// </summary>
4046
[Parameter]
4147
[NotNull]
4248
public string? ClearIcon { get; set; }
4349

4450
/// <summary>
45-
/// Gets or sets the <see cref="IIconTheme"/> service instance.
51+
/// <para lang="zh">获得/设置 <see cref="IIconTheme"/> 服务实例</para>
52+
/// <para lang="en">Gets or sets the <see cref="IIconTheme"/> service instance</para>
4653
/// </summary>
4754
[Inject]
4855
[NotNull]
4956
protected IIconTheme? IconTheme { get; set; }
5057

5158
/// <summary>
52-
/// <see cref="IRegionService"/> service instance
59+
/// <para lang="zh">获得/设置 <see cref="IRegionService"/> 服务实例</para>
60+
/// <para lang="en">Gets or sets the <see cref="IRegionService"/> service instance</para>
5361
/// </summary>
5462
[Inject]
5563
[NotNull]
5664
protected IRegionService? RegionService { get; set; }
5765

5866
/// <summary>
59-
/// 文本框样式
67+
/// <para lang="zh">获得 文本框样式</para>
68+
/// <para lang="en">Gets the input box style</para>
6069
/// </summary>
6170
protected string? InputClassString => CssBuilder.Default("form-select form-control")
6271
.AddClass($"border-{Color.ToDescriptionString()}", Color != Color.None && !IsDisabled && !IsValid.HasValue)
@@ -66,7 +75,8 @@ public abstract class SelectRegionBase : PopoverSelectBase<string>
6675
.Build();
6776

6877
/// <summary>
69-
/// 下拉框按钮样式
78+
/// <para lang="zh">获得 下拉框按钮样式</para>
79+
/// <para lang="en">Gets the dropdown button style</para>
7080
/// </summary>
7181
protected string? AppendClassString => CssBuilder.Default("form-select-append")
7282
.AddClass($"text-{Color.ToDescriptionString()}", Color != Color.None && !IsDisabled && !IsValid.HasValue)
@@ -75,7 +85,8 @@ public abstract class SelectRegionBase : PopoverSelectBase<string>
7585
.Build();
7686

7787
/// <summary>
78-
/// 清空按钮样式
88+
/// <para lang="zh">获得 清空按钮样式</para>
89+
/// <para lang="en">Gets the clear button style</para>
7990
/// </summary>
8091
protected string? ClearClassString => CssBuilder.Default("clear-icon")
8192
.AddClass($"text-{Color.ToDescriptionString()}", Color != Color.None)
@@ -84,7 +95,8 @@ public abstract class SelectRegionBase : PopoverSelectBase<string>
8495
.Build();
8596

8697
/// <summary>
87-
/// 获得 选择框组件 Id
98+
/// <para lang="zh">获得 选择框组件 Id</para>
99+
/// <para lang="en">Gets the select component Id</para>
88100
/// </summary>
89101
protected string InputId => $"{Id}_input";
90102

‎src/components/BootstrapBlazor.Region/Data/CityItem.cs‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
1-
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
1+
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33
// Website: https://www.blazor.zone or https://argozhang.github.io/
44

55
namespace BootstrapBlazor.Components;
66

7+
/// <summary>
8+
/// <para lang="zh">城市项</para>
9+
/// <para lang="en">City item</para>
10+
/// </summary>
711
readonly record struct CityItem
812
{
13+
/// <summary>
14+
/// <para lang="zh">获得 名称</para>
15+
/// <para lang="en">Gets the name</para>
16+
/// </summary>
917
public string Name { get; init; }
1018

19+
/// <summary>
20+
/// <para lang="zh">获得 拼音集合</para>
21+
/// <para lang="en">Gets the pinyin collection</para>
22+
/// </summary>
1123
public HashSet<string> PinYin { get; init; }
1224
}

‎src/components/BootstrapBlazor.Region/Data/CountyItem.cs‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1-
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
1+
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33
// Website: https://www.blazor.zone or https://argozhang.github.io/
44

55
namespace BootstrapBlazor.Components;
66

77
/// <summary>
8-
/// Region 类
8+
/// <para lang="zh">区县项</para>
9+
/// <para lang="en">County item</para>
910
/// </summary>
1011
public readonly record struct CountyItem
1112
{
1213
/// <summary>
13-
/// 城市编码
14+
/// <para lang="zh">获得 城市编码</para>
15+
/// <para lang="en">Gets the city code</para>
1416
/// </summary>
1517
public string Code { get; init; }
1618

1719
/// <summary>
18-
/// 城市名称
20+
/// <para lang="zh">获得 城市名称</para>
21+
/// <para lang="en">Gets the city name</para>
1922
/// </summary>
2023
public string Name { get; init; }
2124
}

‎src/components/BootstrapBlazor.Region/Data/ProvinceItem.cs‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
1-
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
1+
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33
// Website: https://www.blazor.zone or https://argozhang.github.io/
44

55
namespace BootstrapBlazor.Components;
66

7+
/// <summary>
8+
/// <para lang="zh">省份项</para>
9+
/// <para lang="en">Province item</para>
10+
/// </summary>
711
readonly record struct ProvinceItem
812
{
13+
/// <summary>
14+
/// <para lang="zh">获得 名称</para>
15+
/// <para lang="en">Gets the name</para>
16+
/// </summary>
917
public string Name { get; init; }
1018

19+
/// <summary>
20+
/// <para lang="zh">获得 拼音集合</para>
21+
/// <para lang="en">Gets the pinyin collection</para>
22+
/// </summary>
1123
public HashSet<string> PinYin { get; init; }
1224

25+
/// <summary>
26+
/// <para lang="zh">获得 城市集合</para>
27+
/// <para lang="en">Gets the cities collection</para>
28+
/// </summary>
1329
public HashSet<CityItem> Cities { get; init; }
1430
}

‎src/components/BootstrapBlazor.Region/Extensions/ServiceCollectionExtension.cs‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
1+
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33
// Website: https://www.blazor.zone or https://argozhang.github.io/
44

@@ -7,15 +7,16 @@
77
namespace BootstrapBlazor.Components;
88

99
/// <summary>
10-
/// BootstrapBlazor service extensions
10+
/// <para lang="zh">BootstrapBlazor 服务扩展</para>
11+
/// <para lang="en">BootstrapBlazor service extensions</para>
1112
/// </summary>
1213
public static class ServiceCollectionExtension
1314
{
1415
/// <summary>
15-
/// Inject <see cref="IRegionService"/> service extension method.
16+
/// <para lang="zh">注入 <see cref="IRegionService"/> 服务扩展方法</para>
17+
/// <para lang="en">Injects <see cref="IRegionService"/> service extension method</para>
1618
/// </summary>
1719
/// <param name="services"></param>
18-
/// <returns></returns>
1920
public static IServiceCollection AddBootstrapBlazorRegionService(this IServiceCollection services)
2021
{
2122
services.AddSingleton<IRegionService, DefaultRegionService>();

‎src/components/BootstrapBlazor.Region/Services/IRegionService.cs‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,39 @@
1-
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
1+
// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33
// Website: https://www.blazor.zone or https://argozhang.github.io/
44

55
namespace BootstrapBlazor.Components;
66

77
/// <summary>
8-
/// IRegion 获得行政区域数据接口
8+
/// <para lang="zh">获得行政区域数据接口</para>
9+
/// <para lang="en">Region data service interface</para>
910
/// </summary>
1011
public interface IRegionService
1112
{
1213
/// <summary>
13-
/// 获得所有省份数据
14+
/// <para lang="zh">获得所有省份数据</para>
15+
/// <para lang="en">Gets all province data</para>
1416
/// </summary>
15-
/// <returns></returns>
1617
HashSet<string> GetProvinces();
1718

1819
/// <summary>
19-
/// 获得指定省份的城市数据
20+
/// <para lang="zh">获得指定省份的城市数据</para>
21+
/// <para lang="en">Gets cities for the specified province</para>
2022
/// </summary>
2123
/// <param name="province"></param>
22-
/// <returns></returns>
2324
HashSet<string> GetCities(string province);
2425

2526
/// <summary>
26-
/// 获得指定城市的区县数据
27+
/// <para lang="zh">获得指定城市的区县数据</para>
28+
/// <para lang="en">Gets counties for the specified city</para>
2729
/// </summary>
2830
/// <param name="city"></param>
29-
/// <returns></returns>
3031
HashSet<CountyItem> GetCounties(string city);
3132

3233
/// <summary>
33-
/// 获得指定区县的街道地址数据
34+
/// <para lang="zh">获得指定区县的街道地址数据</para>
35+
/// <para lang="en">Gets detail addresses for the specified county</para>
3436
/// </summary>
3537
/// <param name="countyCode"></param>
36-
/// <returns></returns>
3738
HashSet<string> GetDetails(string countyCode);
3839
}

0 commit comments

Comments
 (0)