refactor(Editor): remove BootstrapBlazor.SummerNote.callbacks #863
+2
−24
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's guide (collapsed on small PRs)Reviewer's GuideRefactors the SummerNote editor integration by removing the global BootstrapBlazor.SummerNote.callbacks wiring in JavaScript and making a small documentation improvement to the Editor IsEditor parameter. Sequence diagram for SummerNote editor initialization and image upload callback after callbacks refactorsequenceDiagram
actor Developer
participant EditorComponent
participant JSRuntime
participant EditorJs
participant DataStore
participant SummernoteInstance
Developer->>EditorComponent: Render Editor
EditorComponent->>JSRuntime: InvokeVoidAsync init(id, invoker, methods, height, value, lang,...)
JSRuntime->>EditorJs: init(id, invoker, methodGetPluginAttrs, methodClickPluginItem, height, value, lang, langUrl, hasUpload)
EditorJs->>EditorJs: const el = document.getElementById(id)
EditorJs->>EditorJs: Build toolbar and option
EditorJs->>EditorJs: option.toolbar = toolbar
alt hasUpload is true
EditorJs->>EditorJs: option.callbacks.onImageUpload = async files => {...}
end
EditorJs->>SummernoteInstance: Initialize summernote with option
EditorJs->>DataStore: Data.set(id, editor)
rect rgb(230,230,250)
SummernoteInstance-->>EditorJs: onImageUpload(files)
EditorJs->>EditorJs: editor.files = files
EditorJs->>EditorJs: await addUploadScriptIfNeeded()
EditorJs->>JSRuntime: invoker.invokeMethodAsync(methodClickPluginItem, ...)
end
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Removing the
window.BootstrapBlazor.SummerNote.callbackswiring is a breaking change for anyone using those global callbacks; consider either providing a migration path (e.g., a new event API on the component) or adding a runtime warning when callbacks are still present to make the breakage more discoverable. - Now that the global
BootstrapBlazorobject creation is removed from this file, double-check that no other SummerNote-related scripts still rely onwindow.BootstrapBlazorbeing defined implicitly here, or consider centralizing its initialization in a single shared script if it is still needed elsewhere.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Removing the `window.BootstrapBlazor.SummerNote.callbacks` wiring is a breaking change for anyone using those global callbacks; consider either providing a migration path (e.g., a new event API on the component) or adding a runtime warning when callbacks are still present to make the breakage more discoverable.
- Now that the global `BootstrapBlazor` object creation is removed from this file, double-check that no other SummerNote-related scripts still rely on `window.BootstrapBlazor` being defined implicitly here, or consider centralizing its initialization in a single shared script if it is still needed elsewhere.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Pull request overview
This PR refactors the Editor component by removing the legacy BootstrapBlazor.SummerNote.callbacks functionality that allowed external JavaScript code to register custom event callbacks. The change simplifies the codebase by removing unused infrastructure while maintaining all existing component functionality.
Key Changes:
- Removed the
reloadCallbacksfunction and associated callback registration mechanism from the JavaScript initialization - Removed the
BootstrapBlazornamespace initialization check that was only needed for the callbacks feature - Updated documentation for the
IsEditorproperty to include default value - Bumped package version to 10.0.2
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| Editor.razor.js | Removed callback registration infrastructure including the reloadCallbacks function and BootstrapBlazor namespace initialization |
| Editor.razor.cs | Enhanced documentation by adding default value information to the IsEditor property comment |
| BootstrapBlazor.SummerNote.csproj | Version bump from 10.0.1 to 10.0.2 reflecting the refactoring changes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Link issues
fixes #862
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Simplify the SummerNote editor integration by removing support for global JavaScript callback registration and clarifying the IsEditor parameter documentation.
Enhancements: