-
Notifications
You must be signed in to change notification settings - Fork 1
Refactor connector name and use proper annotation #19
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.
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
Conversation
WalkthroughReplaced Vaadin @javascript annotation with @jsmodule in BaseMarkdownComponent and updated the referenced frontend connector from ./connector.js to ./fcMarkdownEditorConnector.js. Adjusted the import accordingly. No other code or API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Assessment against linked issues
Possibly related issues
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/main/java/com/flowingcode/vaadin/addons/markdown/BaseMarkdownComponent.java (2)
92-95: Defensive guard to avoid runtime errors if the connector fails to loadOptional but safer: guard the calls so a missing or delayed connector doesn’t throw at runtime.
Apply this diff:
- runBeforeClientResponse(ui -> ui.getPage().executeJs( - "window.Vaadin.Flow.fcMarkdownEditorConnector.observeThemeChange($0)", - getElement())); + runBeforeClientResponse(ui -> ui.getPage().executeJs( + "var c=window.Vaadin && Vaadin.Flow && Vaadin.Flow.fcMarkdownEditorConnector;" + + "if (c && c.observeThemeChange) { c.observeThemeChange($0); }", + getElement())); @@ - getUI().ifPresent(ui -> ui.getPage().executeJs( - "window.Vaadin.Flow.fcMarkdownEditorConnector.unobserveThemeChange($0)", - this.getElement())); + getUI().ifPresent(ui -> ui.getPage().executeJs( + "var c=window.Vaadin && Vaadin.Flow && Vaadin.Flow.fcMarkdownEditorConnector;" + + "if (c && c.unobserveThemeChange) { c.unobserveThemeChange($0); }", + this.getElement()));Also applies to: 101-104
55-63: Fix swapped Javadocs for getContent/setContentThe Javadoc summaries are inverted. Also, the @param description for setContent is misleading.
Apply this diff:
- /** - * Sets the content of the Markdown component. - * - * @return the content of the Markdown component - */ + /** + * Gets the content of the Markdown component. + * + * @return the content of the Markdown component + */ @@ - /** - * Gets the content of the Markdown component. - * - * @param content retrieved from the state of the component - */ + /** + * Sets the content of the Markdown component. + * + * @param content content to be used in the Markdown component + */Also applies to: 64-72
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these settings in your CodeRabbit configuration.
📒 Files selected for processing (1)
src/main/java/com/flowingcode/vaadin/addons/markdown/BaseMarkdownComponent.java(2 hunks)
🔇 Additional comments (2)
src/main/java/com/flowingcode/vaadin/addons/markdown/BaseMarkdownComponent.java (2)
27-27: Switching to @jsmodule for Vaadin 24+ is correct — LGTMReplacing @javascript with @jsmodule aligns with Vaadin’s Vite/ESM pipeline and avoids global script pollution. No issues here.
40-40: Connector ESM verified — API presentVerified that:
- File: src/main/resources/META-INF/resources/frontend/fcMarkdownEditorConnector.js
- window.Vaadin.Flow.fcMarkdownEditorConnector defined (line 22)
- observeThemeChange defined (line 23)
- unobserveThemeChange defined (line 74)
- No leftover references to "connector.js" found.
- No top-level use of
this(only occurrence is in the license header).No changes required.
Close #17 & #18
Summary by CodeRabbit
Refactor
Chores