https://github.com/xdev-software/vaadin-grid-filter

A Vaadin Flow component for filtering Grids
https://github.com/xdev-software/vaadin-grid-filter

vaadin vaadin-grid vaadin-grid-filter

Last synced: 7 months ago
JSON representation

A Vaadin Flow component for filtering Grids

• Host: GitHub
• URL: https://github.com/xdev-software/vaadin-grid-filter
• Owner: xdev-software
• License: apache-2.0
• Created: 2024-09-23T11:03:18.000Z (over 1 year ago)
• Default Branch: develop
• Last Pushed: 2025-02-24T04:14:00.000Z (10 months ago)
• Last Synced: 2025-02-24T04:23:00.861Z (10 months ago)
• Topics: vaadin, vaadin-grid, vaadin-grid-filter
• Language: Java
• Homepage: https://vaadin.com/directory/component/grid-filter-for-vaadin
• Size: 1.67 MB
• Stars: 13
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0?logo=vaadin)](https://vaadin.com/directory/component/grid-filter-for-vaadin)

[![Latest version](https://img.shields.io/maven-central/v/software.xdev/vaadin-grid-filter?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/vaadin-grid-filter)

[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-grid-filter/check-build.yml?branch=develop)](https://github.com/xdev-software/vaadin-grid-filter/actions/workflows/check-build.yml?query=branch%3Adevelop)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_vaadin-grid-filter&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_vaadin-grid-filter)

![Vaadin 24+](https://img.shields.io/badge/Vaadin%20Platform/Flow-24+-00b4f0)

# vaadin-grid-filter

A customizable Vaadin Flow component for filtering Grids.

![demo](assets/demo.png)

## Features

* Customizable and dynamic filter UI

  * Most common filters, operations and value types are supported out of the box

  * Nested filters (AND, OR, NOT)

    * depth can be limited

  * customizable operations (=,>,<,contains,is empty)

  * support for multiple value types

    * can easily be bound with Vaadin components

* Query parameter support

* Support for custom translations

> [!NOTE]

> If you are looking for a simpler component you may check out our [simple-grid-filter](https://github.com/xdev-software/vaadin-simple-grid-filter).

## Usage

Here is a very simple example how the GridFilter can be used:

```java

Grid grid = createGrid();

GridFilter filter = GridFilter.createDefault(grid)

  .withFilterableField("ID", Person::id, Integer.class)

  .withFilterableField("First Name", Person::firstName, String.class);

this.add(filter, grid);

```

To get started further it's recommended to have a look at the [demo](./vaadin-grid-filter-demo).


A description how to get it running can be found [below](#run-the-demo).

> [!IMPORTANT]

> This component is designed for "in memory" filtering of small to medium sized amounts of data.

> [!NOTE]

> Filtering multiple thousand items with complex filtering conditions can drastically impact performance and make the UI unresponsive!
 In these cases it's recommended to use backend filtering solutions like database queries or search engines like [ElasticSearch](https://en.wikipedia.org/wiki/Elasticsearch) in combination with a customized UI search framework. If you need help in implementing these feel free to [contact us](https://xdev.software/en/services/support).

## Installation

[Installation guide for the latest release](https://github.com/xdev-software/vaadin-grid-filter/releases/latest#Installation)

#### Compatibility with Vaadin

| Vaadin version | Grid-Filter version |

| --- | --- |

| Vaadin 24+ (latest) | ``1+`` |

### Spring-Boot

* You may have to include ``software/xdev`` inside [``vaadin.allowed-packages``](https://vaadin.com/docs/latest/integrations/spring/configuration#configure-the-scanning-of-packages)

## Run the Demo

* Checkout the repo

* Run ``mvn install && mvn -f vaadin-grid-filter-demo spring-boot:run``

* Open http://localhost:8080

  Show example

  

  ![demo](assets/demo.avif)

## Support

If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).

## Contributing

See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.

## Dependencies and Licenses

View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/vaadin-grid-filter/dependencies)