Skip to content

Conversation

@paodb
Copy link
Member

@paodb paodb commented Sep 23, 2025

See #159 (comment)

Summary by CodeRabbit

  • Documentation
    • Clarified styling limitations: added a note explaining that applying custom CSS classes from stylesheets injected into a component’s shadow root is not supported.
    • Included a link to community discussions outlining possible workarounds.
    • No functional or behavioral changes; this update is informational only.
@paodb paodb requested a review from javier-godoy September 23, 2025 19:59
@coderabbitai
Copy link

coderabbitai bot commented Sep 23, 2025

Walkthrough

Adds a Javadoc note to MarkerLabel.className explaining current styling limitations when using imported stylesheets in the component’s shadow root and links to a GitHub discussion. No code or API changes.

Changes

Cohort / File(s) Summary of Changes
Docs update (Javadoc)
src/main/java/com/flowingcode/vaadin/addons/googlemaps/MarkerLabel.java
Added Javadoc note on limitations of applying className via imported stylesheet in shadow root; included GitHub link. No behavioral changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • Add Marker's Label #157 — Introduced MarkerLabel.className; current PR updates its Javadoc to document styling limitations for that field.

Suggested reviewers

  • javier-godoy

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly and accurately summarizes the primary change: a documentation note about the marker label's className property limitations. It uses the conventional "docs:" scope and names the affected feature, making it clear to reviewers and matching the Javadoc-only change in MarkerLabel.java.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch issue-159

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews: pre_merge_checks: custom_checks: - name: "Undocumented Breaking Changes" mode: "warning" instructions: |  Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a 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 (1)
src/main/java/com/flowingcode/vaadin/addons/googlemaps/MarkerLabel.java (1)

72-77: Minor wording tweak for precision and longevity.
Rephrase to clarify that styles don’t take effect when CSS is imported into the component’s shadow root, rather than “apply the className”. No behavior change; purely editorial.

- * <p> - * <strong>Note:</strong> At the moment, there is no direct way to apply the className by - * importing a stylesheet into the component's shadow root. For alternative workarounds, see - * <a href="https://github.com/FlowingCode/GoogleMapsAddon/issues/159#issuecomment-3325302923"> - * this comment on GitHub</a>. + * <p> + * <strong>Note:</strong> Styles referenced by <code>className</code> are not applied when the + * stylesheet is imported into this component's shadow root. For workarounds and discussion, see + * <a href="https://github.com/FlowingCode/GoogleMapsAddon/issues/159#issuecomment-3325302923"> + * the corresponding GitHub comment</a>.

Please confirm whether this limitation is version‑specific (e.g., certain Vaadin platform versions or addon versions). If so, consider adding that scope to the note to reduce ambiguity for users.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ccceca0 and 2a65555.

📒 Files selected for processing (1)
  • src/main/java/com/flowingcode/vaadin/addons/googlemaps/MarkerLabel.java (1 hunks)
🔇 Additional comments (1)
src/main/java/com/flowingcode/vaadin/addons/googlemaps/MarkerLabel.java (1)

72-77: Helpful clarification; thanks for documenting the limitation.
The added note is valuable and scoped to the right property.

@javier-godoy javier-godoy merged commit 9970003 into master Sep 24, 2025
6 checks passed
@javier-godoy javier-godoy deleted the issue-159 branch September 24, 2025 04:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants