feat: add CSS class for Read-Only mode

[javier-godoy]

Close #178

Summary by CodeRabbit

• New Features

  • Enhanced visual representation of the TwinColGrid component by applying a "readonly" CSS class when in read-only mode.

• Bug Fixes

  • Improved management of selection modes based on the read-only status.

[coderabbitai]

Walkthrough

The changes in this pull request modify the setReadOnly method of the TwinColGrid class to include a new line that assigns the CSS class "readonly" when the method is called with a true parameter. This addition allows the component to visually indicate its read-only state through CSS, while the existing logic for managing selection modes remains unchanged.

Changes

File Path	Change Summary
src/main/java/com/flowingcode/vaadin/addons/twincolgrid/TwinColGrid.java	Modified setReadOnly method to add "readonly" CSS class when readOnly is true.

Assessment against linked issues

Objective	Addressed	Explanation
Add CSS class for Read-Only mode (#178)	✅

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

src/main/java/com/flowingcode/vaadin/addons/twincolgrid/TwinColGrid.java (1)

687-687: LGTM! Consider documenting the CSS class.

The implementation correctly adds the "readonly" CSS class. This change aligns with the PR objectives and follows Vaadin's component styling patterns.

Consider adding a Javadoc comment to document the new CSS class, helping developers understand how to style read-only components:

  /**
   * Sets the component to read-only mode.
   * When enabled:
   * - Grids will be set to NONE selection mode
   * - All buttons will be disabled
   * - A CSS class "readonly" will be added for custom styling
   * @param readOnly true to set component to read-only mode
   */

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ccd465d and a6e2b70.

📒 Files selected for processing (1)

• src/main/java/com/flowingcode/vaadin/addons/twincolgrid/TwinColGrid.java (1 hunks)

🧰 Additional context used