Vaadin Flow integration of https://github.com/ThomasCybulski/paper-chip, based on https://github.com/bastiion/paper-chip for Polymer 3 support
Try the add-on demo at http://addonsv14.flowingcode.com/chipfield
Official releases of this add-on are available at Vaadin Directory. For Maven instructions, download and reviews, go to https://vaadin.com/directory/component/chipfield-addon
git clone https://github.com/FlowingCode/ChipFieldAddon.git mvn clean install jetty:run
To see the demo, navigate to http://localhost:8080/
For further development of this add-on, the following tool-chain is recommended:
- Eclipse IDE
- m2e wtp plug-in (install it from Eclipse Marketplace)
- Vaadin Eclipse plug-in (install it from Eclipse Marketplace)
- JRebel Eclipse plug-in (install it from Eclipse Marketplace)
- Chrome browser
Choose File > Import... > Existing Maven Projects
Note that Eclipse may give "Plugin execution not covered by lifecycle configuration" errors for pom.xml. Use "Permanently mark goal resources in pom.xml as ignored in Eclipse build" quick-fix to mark these errors as permanently ignored in your project. Do not worry, the project still works fine.
To debug project and make code modifications on the fly in the server-side, right-click the project and choose Debug As > Debug on Server. Navigate to http://localhost:8080/ to see the application.
- First release of the addon
This component is developed as a hobby with no public roadmap or any guarantees of upcoming releases.
The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.
Contributions are welcome. There are two primary ways you can contribute: by reporting issues or by submitting code changes through pull requests. To ensure a smooth and effective process for everyone, please follow the guidelines below for the type of contribution you are making.
Creating an issue is a highly valuable contribution. If you've found a bug or have an idea for a new feature, this is the place to start.
- Before creating an issue, please check the existing issues to see if your topic is already being discussed.
- If not, create a new issue, choosing the right option: "Bug Report" or "Feature Request". Try to keep the scope minimal but as detailed as possible.
A Note on Bug Reports
Please complete all the requested fields to the best of your ability. Each piece of information, like the environment versions and a clear description, helps us understand the context of the issue.
While all details are important, the minimal, reproducible example is the most critical part of your report. It's essential because it removes ambiguity and allows our team to observe the problem firsthand, exactly as you are experiencing it.
As a first step, please refer to our Development Conventions page to find information about Conventional Commits & Code Style requirements.
Then, follow these steps for creating a contribution:
- Fork this project.
- Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
- For commit message, use Conventional Commits to describe your change.
- Send a pull request for the original project.
- Comment on the original issue that you have implemented a fix for it.
This add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.
ChipFieldAddon is written by Flowing Code S.A.
Here is a simple example on how to try out the add-on component:
List<Planet> availablePlanets = new ArrayList<>(Arrays.asList(new Planet("Mercury"), new Planet("Venus"), new Planet("Earth")));
ListDataProvider<Planet> ldp = new ListDataProvider<>(availablePlanets);
ChipField<Planet> chf = new ChipField<>("Choose planets", planet->planet.getName());
chf.setDataProvider(ldp);
chf.setClosable(true);
chf.setNewItemHandler(label->new Planet(label));
For a more comprehensive example, see com.flowingcode.vaadin.addons.chipfield.DemoView
ChipField<String> chf = new ChipField<>("Select some planets", "Mercury", "Venus", "Earth", "Mars", "Jupiter", "Saturn", "Uranus", "Neptune");
Button b = new Button("Obtain selected planets");
b.addClickListener(event->Notification.show("Planets: " + chf.getValue().stream().collect(Collectors.joining(",")));
ChipField<String> chf5 = new ChipField<>("Choose planet features (Binder demo, try with: 'Rings', 'Moons', 'Water', etc.)");
chf5.setWidth("500px");
chf5.setItems(Arrays.asList("Rings", "Moons", "Water", "Rocks", "Lava", "Ice", "Cold", "Heat", "Atmosphere"));
Binder<Planet> binder = new Binder<>();
binder.bind(chf5,Planet::getConfiguration,Planet::setConfiguration);
binder.setBean(p);
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.