Skip to content

doc(Editor): update EditorUploadFile docmentation #7397

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 3 commits into from
Dec 23, 2025
Merged

doc(Editor): update EditorUploadFile docmentation #7397

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
79af947
chore: update version to 10.0.2
ArgoZhang Dec 22, 2025
e444fab
doc(Editor): update docmentation
ArgoZhang Dec 22, 2025
84d26a1
Merge branch 'main' into refactor-editor
ArgoZhang Dec 23, 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
2 changes: 1 addition & 1 deletion src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
<PackageReference Include="BootstrapBlazor.Sortable" Version="10.0.0" />
<PackageReference Include="BootstrapBlazor.Splitting" Version="10.0.0" />
<PackageReference Include="BootstrapBlazor.SvgEditor" Version="10.0.0" />
<PackageReference Include="BootstrapBlazor.SummerNote" Version="10.0.1" />
<PackageReference Include="BootstrapBlazor.SummerNote" Version="10.0.2" />
<PackageReference Include="BootstrapBlazor.TableExport" Version="10.0.1" />
<PackageReference Include="BootstrapBlazor.Tasks.Dashboard" Version="10.0.0" />
<PackageReference Include="BootstrapBlazor.Topology" Version="10.0.0" />
Expand Down
4 changes: 4 additions & 0 deletions src/BootstrapBlazor.Server/Components/Samples/Editors.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@

<Pre class="no-highlight mb-3">builder.Services.Configure&lt;HubOptions&gt;(option => option.MaximumReceiveMessageSize = null);</Pre>

<p class="code-label">@Localizer["EditorsUploadDesc"]</p>
<Pre>public Func&lt;EditorUploadFile, Task&lt;string&gt;&gt;? OnFileUpload { get; set; }</Pre>
<p>@((MarkupString)Localizer["EditorsUploadDesc2"].Value)</p>

<PackageTips Name="BootstrapBlazor.SummerNote" />

<DemoBlock Title="@Localizer["EditorNormalTitle"]" Introduction="@Localizer["EditorNormalIntro"]" Name="Normal">
Expand Down
2 changes: 2 additions & 0 deletions src/BootstrapBlazor.Server/Locales/en-US.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2460,6 +2460,8 @@
"EditorsTitle": "Editor",
"EditorsDescription": "Convert the entered text into <code>html</code> code snippets",
"EditorsTips": "The <code>Editor</code> component is a secondary package of <a href='https://summernote.org/' target='_blank'><code>Summernote component</code></a>, such as If you need to use the localization function, please download the corresponding language pack from the official website and quote it by yourself. <code>zh-CN</code> <code>en-US</code> has been built in the required <code>css</code> <code>JavaScript</code> dynamically loaded on demand. If you edit too much content, <code>signalR</code> communication interruption may be triggered. Please adjust the <code>HubOptions</code> configuration.",
"EditorsUploadDesc": "Upload File Callback",
"EditorsUploadDesc2": "After the component sets a callback, when a file is selected for upload within the component, it will be returned to the caller as an instance of <code>EditorUploadFile</code>. The <code>Stream</code> property allows saving to the server or directly storing to Cloud Object Storage (OSS). The callback return value is the <b>Url</b> used for previewing the stored file.",
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

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

The English documentation could be clearer. Consider rephrasing "The Stream property allows saving to the server" to "The Stream property allows you to save to the server" or "Through the Stream property, you can save to the server" for better grammatical flow.

Suggested change
"EditorsUploadDesc2": "After the component sets a callback, when a file is selected for upload within the component, it will be returned to the caller as an instance of <code>EditorUploadFile</code>. The <code>Stream</code> property allows saving to the server or directly storing to Cloud Object Storage (OSS). The callback return value is the <b>Url</b> used for previewing the stored file.",
"EditorsUploadDesc2": "After the component sets a callback, when a file is selected for upload within the component, it will be returned to the caller as an instance of <code>EditorUploadFile</code>. The <code>Stream</code> property allows you to save to the server or directly store to Cloud Object Storage (OSS). The callback return value is the <b>Url</b> used for previewing the stored file.",

Copilot uses AI. Check for mistakes.
"EditorNormalTitle": "Basic usage",
"EditorNormalIntro": "The default rendering is <code>div</code> and it becomes a rich text edit box when clicked",
"EditorNormalDescription": "Set the <code>IsEditor</code> attribute value to control whether the component defaults to <code>div</code> or <code>editor</code>",
Expand Down
2 changes: 2 additions & 0 deletions src/BootstrapBlazor.Server/Locales/zh-CN.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2460,6 +2460,8 @@
"EditorsTitle": "Editor 富文本框",
"EditorsDescription": "将输入的文字转化为 <code>html</code> 代码片段",
"EditorsTips": "<code>Editor</code> 组件是对 <a href='https://summernote.org/' target='_blank'><code>Summernote 组件</code></a> 的二次封装，如需使用本地化功能请自行官网下载相对应语言包，自行引用即可，<code>zh-CN</code> <code>en-US</code> 已内置；组件所需 <code>css</code> <code>JavaScript</code> 均按需动态加载，使用者无需设置。由于 <code>summernote</code> 组件依赖 <b>jQuery</b>，所以需要自行引用 <code>jQuery</code> 脚本包。如果编辑内容过多，可能会触发 <code>signalR</code> 通讯中断问题，请自行调整 <code>HubOptions</code> 配置即可。",
"EditorsUploadDesc": "文件上传回调",
"EditorsUploadDesc2": "组件设置回调后，在组件中选择文件上传时，会以 <code>EditorUploadFile</code> 实例形式返回给调用者，通过其属性 <code>Stream</code> 可以实现保存到服务器或者直接存储到 <b>云对象存储（OSS）</b>中。回调返回值为文件存储后用于预览的 <b>Url</b>",
"EditorNormalTitle": "基础用法",
"EditorNormalIntro": "默认呈现为 <code>div</code> 点击后变为富文本编辑框",
"EditorNormalDescription": "通过设置 <code>IsEditor</code> 属性值来控制组件默认是 <code>div</code> 还是 <code>editor</code>",
Expand Down