Skip to content

docs(readme): document DynamicTheme #141

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.

Sign up for GitHub

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

Merged
paodb merged 1 commit into from
Feb 4, 2026
Merged

docs(readme): document DynamicTheme #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,28 @@ By default, help content will be rendered in a `Dialog`.

![image](https://github.com/FlowingCode/CommonsDemo/assets/11554739/055a447e-a104-4ec7-a98c-fc1df8abef01)

## Dynamic Theme

Available in Vaadin 25+, this feature allows you to verify add-on behavior across the Lumo and Aura themes, as well as with minimal base styles. The theme can be switched at runtime using the theme selector in the footer of the `TabbedDemo` component.

<img width="91" height="106" alt="image" src="https://github.com/user-attachments/assets/cce58a29-f779-477d-89b4-ee845a80b962" />

To enable this feature, the `DynamicTheme` must be initialized in the `AppShellConfigurator` of the application. Ensure that the legacy `@Theme` annotation and any Aura or Lumo `@StyleSheet` references are removed.

```java
public class AppShellConfiguratorImpl implements AppShellConfigurator {

@Override
public void configurePage(AppShellSettings settings) {
if (DynamicTheme.isFeatureSupported()) {
DynamicTheme.LUMO.initialize(settings);
}
}

}
```


## Code Viewer

The code viewer component (`SourceCodeViewer`) is responsible of rendering a Java source file along the demo.
Expand Down