Skip to content

Commit b0ce3d7

Browse files
authored
feat(UniverSheet): update xml comments (#927)
* chore: 更新字典 * doc: 更新文档注释
1 parent 6de3b9e commit b0ce3d7

2 files changed

Lines changed: 29 additions & 18 deletions

File tree

exclusion.dic

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,4 @@ Validata
103103
Validatable
104104
Totp
105105
Vditor
106+
univer

src/components/BootstrapBlazor.UniverSheet/Components/UniverSheet.razor.cs

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,60 +9,70 @@
99
namespace BootstrapBlazor.Components;
1010

1111
/// <summary>
12-
/// UniverSheet 组件
12+
/// <para lang="zh">UniverSheet 组件</para>
13+
/// <para lang="en">UniverSheet component</para>
1314
/// </summary>
1415
public partial class UniverSheet
1516
{
1617
/// <summary>
17-
/// 获得/设置 插件集合 默认 null 未设置
18+
/// <para lang="zh">获得/设置 插件集合 默认 null 未设置</para>
19+
/// <para lang="en">Gets or sets the plugin collection. Default is null.</para>
1820
/// </summary>
1921
[Parameter]
2022
public Dictionary<string, string>? Plugins { get; set; }
2123

2224
/// <summary>
23-
/// 获得/设置 主题颜色 默认 null 未设置 可设置为 greenTheme
25+
/// <para lang="zh">获得/设置 主题颜色 默认 null 未设置 可设置为 greenTheme</para>
26+
/// <para lang="en">Gets or sets the theme color. Default is null. Can be set to greenTheme.</para>
2427
/// </summary>
2528
[Parameter]
2629
public string? Theme { get; set; }
2730

2831
/// <summary>
29-
/// 获得/设置 是否为暗黑模式 默认 null 未设置 自动
32+
/// <para lang="zh">获得/设置 是否为暗黑模式 默认 null 未设置 自动</para>
33+
/// <para lang="en">Gets or sets whether dark mode is enabled. Default is null (auto).</para>
3034
/// </summary>
3135
[Parameter]
3236
public bool? IsDarkMode { get; set; }
3337

3438
/// <summary>
35-
/// 获得/设置 语言 默认 null 未设置
39+
/// <para lang="zh">获得/设置 语言 默认 null 未设置</para>
40+
/// <para lang="en">Gets or sets the language. Default is null.</para>
3641
/// </summary>
3742
[Parameter]
3843
public string? Lang { get; set; }
3944

4045
/// <summary>
41-
/// 获得/设置 设置工具栏样式 默认 default 未设置
46+
/// <para lang="zh">获得/设置 工具栏样式 默认 default 未设置</para>
47+
/// <para lang="en">Gets or sets the ribbon toolbar style. Default is default.</para>
4248
/// </summary>
4349
[Parameter]
4450
public UniverSheetRibbonType RibbonType { get; set; }
4551

4652
/// <summary>
47-
/// 获得/设置 需要传递的数据
53+
/// <para lang="zh">获得/设置 需要传递的数据</para>
54+
/// <para lang="en">Gets or sets the data to pass.</para>
4855
/// </summary>
4956
[Parameter]
5057
public UniverSheetData? Data { get; set; }
5158

5259
/// <summary>
53-
/// 获得/设置 是否显示加载遮罩 默认 true 显示遮罩
60+
/// <para lang="zh">获得/设置 是否显示加载遮罩 默认 true 显示遮罩</para>
61+
/// <para lang="en">Gets or sets whether to show loading mask. Default is true.</para>
5462
/// </summary>
5563
[Parameter]
5664
public bool ShowLoading { get; set; } = true;
5765

5866
/// <summary>
59-
/// 获得/设置 正在加载显示文本 默认 null 未设置读取资源文件
67+
/// <para lang="zh">获得/设置 正在加载显示文本 默认 null 未设置读取资源文件</para>
68+
/// <para lang="en">Gets or sets the loading display text. Default is null, reads from resource file.</para>
6069
/// </summary>
6170
[Parameter]
6271
public string? LoadingText { get; set; }
6372

6473
/// <summary>
65-
/// 获得/设置 Frame 加载页面传递过来的数据
74+
/// <para lang="zh">获得/设置 Frame 加载页面传递过来的数据回调方法</para>
75+
/// <para lang="en">Gets or sets the callback for data posted from the Frame loaded page.</para>
6676
/// </summary>
6777
[Parameter]
6878
public Func<UniverSheetData?, Task<UniverSheetData?>>? OnPostDataAsync { get; set; }
@@ -115,7 +125,6 @@ protected override async Task OnAfterRenderAsync(bool firstRender)
115125
/// <summary>
116126
/// <inheritdoc/>
117127
/// </summary>
118-
/// <returns></returns>
119128
protected override Task InvokeInitAsync() => InvokeVoidAsync("init", Id, Interop, new
120129
{
121130
Theme,
@@ -127,32 +136,33 @@ protected override async Task OnAfterRenderAsync(bool firstRender)
127136
});
128137

129138
/// <summary>
130-
/// 推送数据方法
139+
/// <para lang="zh">推送数据方法</para>
140+
/// <para lang="en">Pushes data to the sheet.</para>
131141
/// </summary>
132142
/// <param name="data"></param>
133-
/// <returns></returns>
134143
public Task<UniverSheetData?> PushDataAsync(UniverSheetData? data) => InvokeAsync<UniverSheetData>("execute", Id, data);
135144

136145
/// <summary>
137-
/// 由 JavaScript 调用
146+
/// <para lang="zh">由 JavaScript 调用</para>
147+
/// <para lang="en">Called by JavaScript.</para>
138148
/// </summary>
139149
/// <param name="data"></param>
140-
/// <returns></returns>
141150
[JSInvokable]
142151
public async Task<UniverSheetData?> TriggerPostData(UniverSheetData data) => OnPostDataAsync == null
143152
? null
144153
: await OnPostDataAsync(data);
145154

146155
/// <summary>
147-
/// 获得/设置 页面加载完毕后回调方法
156+
/// <para lang="zh">获得/设置 页面加载完毕后回调方法</para>
157+
/// <para lang="en">Gets or sets the callback method after page loading is complete.</para>
148158
/// </summary>
149159
[Parameter]
150160
public Func<Task>? OnReadyAsync { get; set; }
151161

152162
/// <summary>
153-
/// 由 JavaScript 调用
163+
/// <para lang="zh">由 JavaScript 调用</para>
164+
/// <para lang="en">Called by JavaScript.</para>
154165
/// </summary>
155-
/// <returns></returns>
156166
[JSInvokable]
157167
public async Task TriggerReadyAsync()
158168
{

0 commit comments

Comments
 (0)