{"id":19725599,"url":"https://github.com/xdev-software/vaadin-grid-filter","last_synced_at":"2025-06-11T23:07:30.099Z","repository":{"id":259570425,"uuid":"861692221","full_name":"xdev-software/vaadin-grid-filter","owner":"xdev-software","description":"A Vaadin Flow component for filtering Grids","archived":false,"fork":false,"pushed_at":"2025-02-24T04:14:00.000Z","size":1752,"stargazers_count":13,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-02-24T04:23:00.861Z","etag":null,"topics":["vaadin","vaadin-grid","vaadin-grid-filter"],"latest_commit_sha":null,"homepage":"https://vaadin.com/directory/component/grid-filter-for-vaadin","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xdev-software.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-23T11:03:18.000Z","updated_at":"2025-02-24T03:09:27.000Z","dependencies_parsed_at":"2024-10-26T16:13:28.972Z","dependency_job_id":"d462de2b-6abc-48c5-a874-81a5ea3de718","html_url":"https://github.com/xdev-software/vaadin-grid-filter","commit_stats":{"total_commits":416,"total_committers":5,"mean_commits":83.2,"dds":"0.40384615384615385","last_synced_commit":"6aa233833f4b5ddf65581a4daed59483c9d5c247"},"previous_names":["xdev-software/vaadin-grid-filter"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdev-software%2Fvaadin-grid-filter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdev-software%2Fvaadin-grid-filter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdev-software%2Fvaadin-grid-filter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdev-software%2Fvaadin-grid-filter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xdev-software","download_url":"https://codeload.github.com/xdev-software/vaadin-grid-filter/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241049366,"owners_count":19900432,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["vaadin","vaadin-grid","vaadin-grid-filter"],"created_at":"2024-11-11T23:31:22.812Z","updated_at":"2025-02-27T19:20:16.823Z","avatar_url":"https://github.com/xdev-software.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"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)\n[![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)\n[![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)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_vaadin-grid-filter\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_vaadin-grid-filter)\n![Vaadin 24+](https://img.shields.io/badge/Vaadin%20Platform/Flow-24+-00b4f0)\n\n# vaadin-grid-filter\n\nA customizable Vaadin Flow component for filtering Grids.\n\n![demo](assets/demo.png)\n\n## Features\n* Customizable and dynamic filter UI\n  * Most common filters, operations and value types are supported out of the box\n  * Nested filters (AND, OR, NOT)\n    * depth can be limited\n  * customizable operations (=,\u003e,\u003c,contains,is empty)\n  * support for multiple value types\n    * can easily be bound with Vaadin components\n* Query parameter support\n* Support for custom translations\n\n\u003e [!NOTE]\n\u003e 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).\n\n## Usage\n\nHere is a very simple example how the GridFilter can be used:\n```java\nGrid\u003cPerson\u003e grid = createGrid();\n\nGridFilter\u003cPerson\u003e filter = GridFilter.createDefault(grid)\n  .withFilterableField(\"ID\", Person::id, Integer.class)\n  .withFilterableField(\"First Name\", Person::firstName, String.class);\n\nthis.add(filter, grid);\n```\n\nTo get started further it's recommended to have a look at the [demo](./vaadin-grid-filter-demo).\u003cbr/\u003e\nA description how to get it running can be found [below](#run-the-demo).\n\n\u003e [!IMPORTANT]\n\u003e This component is designed for \"in memory\" filtering of small to medium sized amounts of data.\n\n\u003e [!NOTE]\n\u003e Filtering multiple thousand items with complex filtering conditions can drastically impact performance and make the UI unresponsive!\u003cbr/\u003e 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).\n\n## Installation\n[Installation guide for the latest release](https://github.com/xdev-software/vaadin-grid-filter/releases/latest#Installation)\n\n#### Compatibility with Vaadin\n\n| Vaadin version | Grid-Filter version |\n| --- | --- |\n| Vaadin 24+ (latest) | ``1+`` |\n\n### Spring-Boot\n* You may have to include ``software/xdev`` inside [``vaadin.allowed-packages``](https://vaadin.com/docs/latest/integrations/spring/configuration#configure-the-scanning-of-packages)\n\n## Run the Demo\n* Checkout the repo\n* Run ``mvn install \u0026\u0026 mvn -f vaadin-grid-filter-demo spring-boot:run``\n* Open http://localhost:8080\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow example\u003c/summary\u003e\n  \n  ![demo](assets/demo.avif)\n\u003c/details\u003e\n\n## Support\nIf 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).\n\n## Contributing\nSee the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.\n\n## Dependencies and Licenses\nView the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/vaadin-grid-filter/dependencies)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxdev-software%2Fvaadin-grid-filter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxdev-software%2Fvaadin-grid-filter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxdev-software%2Fvaadin-grid-filter/lists"}