docs(readme): add special configuration when using Spring #187
Conversation
WalkthroughThe pull request updates the Changes
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~94-~94: Consider a shorter alternative to avoid wordiness.
Context: ...on, the add-on might need to be allowed in order to display correctly.
(IN_ORDER_TO_PREMIUM)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build-vaadin14
javier-godoy
force-pushed
the
javier-godoy-patch-1
branch
from
8937619 to
fcfb4bc
Compare
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (3)
94-94: Make the explanation more concise.Revise the sentence to be more direct:
-By default, Vaadin Flow only includes ```com/vaadin/flow/component``` to be always scanned for UI components and views. For this reason, the add-on might need to be allowed in order to display correctly. +By default, Vaadin Flow only scans ```com/vaadin/flow/component``` for UI components and views. The TwinColGrid add-on requires additional configuration to be recognized.🧰 Tools
🪛 LanguageTool
[style] ~94-~94: Consider a shorter alternative to avoid wordiness.
Context: ...on, the add-on might need to be allowed in order to display correctly.To do so, just a...
(IN_ORDER_TO_PREMIUM)
96-98: Consider providing both configuration options.While the properties file approach is simpler, it would be helpful to provide both configuration options (properties and Java-based) to give users flexibility based on their needs.
Add the Java-based configuration option:
To do so, just add ```com.flowingcode``` to the ```vaadin.allowed-packages``` property in ```src/main/resources/application.properties```, like: ```vaadin.allowed-packages = com.vaadin,org.vaadin,dev.hilla,com.flowingcode``` + +Alternatively, you can use Java-based configuration: + +```java +@Configuration +public class VaadinConfig { + @Bean + public ConfigurationProperties vaadinConfigurationProperties() { + return new ConfigurationProperties() { + @Override + public Set<String> getPackagesToScan() { + return Collections.singleton("com.flowingcode.vaadin.addons"); + } + }; + } +} +```
92-100: Add explanation about why this configuration is needed.The section would benefit from a brief explanation of why this configuration is necessary, helping users understand the purpose.
Add an explanation at the beginning of the section:
## Special configuration when using Spring + +When using TwinColGrid with Spring, additional configuration is needed because the add-on's components are located outside Vaadin's default scanning path. This configuration ensures that Spring can discover and properly initialize the add-on's components.🧰 Tools
🪛 LanguageTool
[style] ~94-~94: Consider a shorter alternative to avoid wordiness.
Context: ...on, the add-on might need to be allowed in order to display correctly.To do so, just a...
(IN_ORDER_TO_PREMIUM)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~94-~94: Consider a shorter alternative to avoid wordiness.
Context: ...on, the add-on might need to be allowed in order to display correctly.
To do so, just a...
(IN_ORDER_TO_PREMIUM)
Summary by CodeRabbit
README.md, providing instructions for configuring the TwinColGrid add-on within a Spring context.