From 695824f6fc67564f53028f00187f9f16675b5460 Mon Sep 17 00:00:00 2001 From: Javier Godoy <11554739+javier-godoy@users.noreply.github.com> Date: Mon, 31 Mar 2025 14:23:18 -0300 Subject: [PATCH] docs(readme): document allowed-packages --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index a15c3f7..cf725ad 100644 --- a/README.md +++ b/README.md @@ -114,3 +114,14 @@ For a more comprehensive example, see com.flowingcode.vaadin.addons.carousel.Dem Button first = new Button("|<"); first.addClickListener(e->cf.movePos(0)); +## Special configuration when using Spring + +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. + +To do so, just add `com.flowingcode` to the `vaadin.allowed-packages` property (Vaadin 14-23: `vaadin.whitelisted-packages`) in `src/main/resources/application.properties`, like: + +``` +vaadin.allowed-packages = com.vaadin,org.vaadin,dev.hilla,com.flowingcode +``` + +More information on Spring scanning configuration [here](https://vaadin.com/docs/latest/integrations/spring/configuration/#configure-the-scanning-of-packages).