Several grid recipes for Vaadin 23+ (and 22), ready to use. DOES NOT require extending Grid
.
- Remove multiselect selection column
- Freeze a grid's selection (checkbox) column
- Create Grid with conditional selection (with the following limitations: #11, #12)
- Select Grid rows automatically using up/down arrow keys
- Show a Vaadin Grid with compact row styling
- Show a meaningful message instead of an empty Grid
- Show a menu to toggle the visibility of grid columns
- git clone repository
- mvn clean install jetty:run
To see the demo, navigate to http://localhost:8080/
See here
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.
Grid Helpers Add-on is written by Flowing Code S.A.
The class GridHelper
provides several static methods that receive a Grid
or Column
as the first parameter:
grid.setSelectionMode(SelectionMode.MULTI);
grid.addThemeName(GridHelper.DENSE_THEME);
GridHelper.setSelectOnClick(grid, true);
GridHelper.setArrowSelectionEnabled(grid, true);
GridHelper.setSelectionColumnHidden(grid, true);
Column<Person> firstNameColumn = grid.addColumn(Person::getFirstName).setHeader("First name");
GridHelper.setHidingToggleCaption(firstNameColumn, "First name");
If you use Project Lombok, you can benefit from the extension method feature:
@ExtensionMethod(GridHelper.class)
public class LombokDemo extends Div {
public LombokDemo() {
Grid<Person> grid = new Grid<>();
grid.setSelectionMode(SelectionMode.MULTI);
grid.setSelectionColumnHidden(true);
grid.setSelectOnClick(true);
grid.setSelectionFilter(Person::isActive);
grid.addColumn(Person::getFirstName)
.setHeader("First name")
.setHidingToggleCaption("First name");
add(grid);
}
}
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 whitelisted in order to display correctly.
To do so, just add com.flowingcode
to the vaadin.whitelisted-packages
property in src/main/resources/application.properties
, like:
vaadin.whitelisted-packages = com.vaadin,org.vaadin,dev.hilla,com.flowingcode
More information on Spring whitelisted configuration here.