Skip to content

doc(UniverSheet): update documentation #944

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
ArgoZhang merged 2 commits into from
Mar 7, 2026
Merged

doc(UniverSheet): update documentation #944

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
369f8b4
doc: 更新注释文档
ArgoZhang Mar 6, 2026
db68c03
Merge branch 'master' into doc-xml
ArgoZhang Mar 7, 2026
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
4 changes: 2 additions & 2 deletions src/components/BootstrapBlazor.UniverSheet/Components/UniverSheet.razor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ public partial class UniverSheet
public string? LoadingText { get; set; }

/// <summary>
/// <para lang="zh">获得/设置 Frame 加载页面传递过来的数据回调方法</para>
/// <para lang="en">Gets or sets the callback for data posted from the Frame loaded page.</para>
/// <para lang="zh">获得/设置 UniverSheet 数据回调方法（一般由 Excel 按钮触发）</para>
/// <para lang="en">Gets or sets the UniverSheet data callback method (usually triggered by the Excel button).</para>
Comment on lines +74 to +75
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updated summary mentions the callback is usually triggered by an “Excel button”, but there’s no corresponding concept in the component/JS (TriggerPostData is invoked via JS interop from wwwroot/data-service.js:getDataAsync). This makes the API documentation misleading for consumers; consider rewording to describe the actual trigger (i.e., invoked when JavaScript calls TriggerPostData / when the sheet requests data from .NET) rather than a specific UI element.

Suggested change
/// <para lang="zh">获得/设置 UniverSheet 数据回调方法（一般由 Excel 按钮触发）</para>
/// <para lang="en">Gets or sets the UniverSheet data callback method (usually triggered by the Excel button).</para>
/// <para lang="zh">获得/设置 UniverSheet 数据回调方法（由前端通过 JavaScript 调用 TriggerPostData 或工作表向 .NET 请求数据时触发）</para>
/// <para lang="en">Gets or sets the UniverSheet data callback method (invoked when JavaScript calls TriggerPostData, i.e., when the sheet requests data from .NET).</para>

Copilot uses AI. Check for mistakes.
/// </summary>
[Parameter]
public Func<UniverSheetData?, Task<UniverSheetData?>>? OnPostDataAsync { get; set; }
Expand Down