Filterable Layout Add-on for Vaadin 14+

Filterable Layout is an extension for Vaadin 14+, that allows you to build forms that can be filtered to only display components with a certain caption.

Online demo

Online demo here

Download release

Available in Vaadin Directory

Building and running demo

• git clone repository
• mvn clean install jetty:run

To see the demo, navigate to http://localhost:8080/

Release notes

• Version 2.0.0 Initial release for Vaadin 14+ NPM mode

Roadmap

• Support for more container components

Issue tracking

The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.

Contributions

Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:

• 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.
• Refer to the fixed issue in commit
• Send a pull request for the original project
• Comment on the original issue that you have implemented a fix for it

License & Author

This add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.

AppLayout is written by Flowing Code S.A.

Developer Guide

Getting started

Instantiating

    VerticalLayout vl = new VerticalLayout();
	...
	TextField filter = createTextField("Filter");
	FilterableLayoutExtension flayout = new FilterableLayoutExtension(filter, vl.getElement());

Adding a filtered style

	flayout.setFilteredStyleName("filtered");

Configuring it to hide or not filtered components

	Checkbox cb = new Checkbox("Hide filtered components");
	cb.setValue(true);
	cb.addValueChangeListener(e -> {
		flayout.setHideFilteredComponents(e.getValue());
		flayout.filterComponents(filter.getValue(), vl.getElement());
	});