Skip to content

Commit 33b4a73

Browse files
authored
Update README.md
1 parent 7df6700 commit 33b4a73

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,29 @@ A simple Vaadin Flow component for filtering Grids.
1010

1111
![demo](assets/demo.png)
1212

13+
> [!NOTE]
14+
> If you are looking for a more advanced component you may check out our [grid-filter](https://github.com/xdev-software/vaadin-grid-filter).
15+
16+
## Usage
17+
18+
Here is a very simple example how the FilterComponent can be used:
19+
```java
20+
Grid<Person> grid = createGrid();
21+
22+
FilterComponent<Person> filter = new FilterComponent<>(grid)
23+
.withFilter(new SimpleFilterField<>(Person::getLastName, "Lastname"));
24+
25+
this.add(filter, grid);
26+
```
27+
28+
To get started further it's recommended to have a look at the [demo](./vaadin-simple-grid-filter-demo).<br/>
29+
A description how to get it running can be found [below](#run-the-demo).
30+
31+
> [!IMPORTANT]
32+
> This component is designed for "in memory" filtering of small to medium sized amounts of data.
33+
34+
> [!NOTE]
35+
> Filtering multiple thousand items with complex filtering conditions can drastically impact performance and make the UI unresponsive!<br/> 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).
1336
1437
## Installation
1538
[Installation guide for the latest release](https://github.com/xdev-software/vaadin-simple-grid-filter/releases/latest#Installation)

0 commit comments

Comments
 (0)