Skip to content

Document Badge component experimental feature and exclude feature flags from jar #45

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
javier-godoy merged 2 commits into from
Apr 21, 2026
+14 −0
Merged

Document Badge component experimental feature and exclude feature flags from jar #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d4b3e7
docs(readme): document Badge experimental feature flag requirement
paodb Apr 20, 2026
1b3f852
build: exclude vaadin-featureflags.properties from add-on jar
paodb Apr 20, 2026
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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,19 @@ Badge List Add-on is written by Flowing Code S.A.

# Developer Guide

## Enabling the Badge component

Since version 2.0.0, this add-on uses the preview version of Badge component from Vaadin core (`com.vaadin.flow.component.badge.Badge`). As is currently an experimental feature it must be explicitly enabled in your project before using this add-on.

You can enable it in one of two ways:

- Through **Vaadin Copilot**, in the experimental features panel.
- By adding the following line to `src/main/resources/vaadin-featureflags.properties` in your project:

```properties
com.vaadin.experimental.badgeComponent=true
```

## Getting started

```java
Expand Down
1 change: 1 addition & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,7 @@
<!-- Generated file that shouldn't be included in add-ons -->
<excludes>
<exclude>META-INF/VAADIN/config/flow-build-info.json</exclude>
<exclude>**/vaadin-featureflags.properties</exclude>
</excludes>
</configuration>
</plugin>
Expand Down
Loading