Filter nested column in PrimeNG Table (Angular)

3 min read 24-09-2024
Filter nested column in PrimeNG Table (Angular)


When working with complex data structures in Angular, displaying nested columns in a PrimeNG table can be challenging, especially when it comes to filtering the data effectively. In this article, we'll tackle the issue of filtering nested columns in a PrimeNG table and provide a clear, step-by-step guide along with practical examples to enhance your understanding.

Understanding the Problem

The problem arises when we want to filter a PrimeNG table that contains nested objects. For instance, suppose we have the following data structure for a table:

this.data = [
  { id: 1, name: 'John', details: { age: 30, address: { city: 'New York', zip: '10001' } } },
  { id: 2, name: 'Jane', details: { age: 25, address: { city: 'Los Angeles', zip: '90001' } } },
  { id: 3, name: 'Mike', details: { age: 35, address: { city: 'Chicago', zip: '60601' } } }
];

In this dataset, each entry has nested objects for details, which further includes another nested object for address. The challenge here is to implement a filter that can work on these nested properties, such as filtering by details.age or details.address.city.

Filtering Nested Columns in PrimeNG Table

To filter a PrimeNG table with nested columns, we will need to customize the filter function. Here’s how you can achieve that:

  1. Set up the PrimeNG Table in your Component: Include PrimeNG modules in your Angular project and create a basic PrimeNG table structure in your component HTML.
<p-table [value]="data" [paginator]="true" [rows]="10">
  <ng-template pTemplate="header">
    <tr>
      <th>Name</th>
      <th>Age</th>
      <th>City</th>
    </tr>
  </ng-template>
  <ng-template pTemplate="body" let-rowData>
    <tr>
      <td>{{ rowData.name }}</td>
      <td>{{ rowData.details.age }}</td>
      <td>{{ rowData.details.address.city }}</td>
    </tr>
  </ng-template>
</p-table>
  1. Implement the Filter Logic: Now, let’s add a filter function in the component to accommodate filtering based on nested properties.
filterGlobal(event: any, stringVal: string) {
  const filterValue = event.target.value.toLowerCase();
  this.data = this.data.filter(item => 
    item.name.toLowerCase().includes(filterValue) ||
    item.details.age.toString().includes(filterValue) ||
    item.details.address.city.toLowerCase().includes(filterValue)
  );
}
  1. Add Input for Filtering: Include an input field in your HTML template to allow users to enter their filter criteria.
<input type="text" (input)="filterGlobal($event, 'global')" placeholder="Filter by Name, Age or City">

Analyzing the Solution

This approach simplifies the filtering process by creating a unified input for multiple fields, including those within nested objects. The filterGlobal function checks whether the input value matches the specified fields, allowing for intuitive searches.

Advantages:

  • User-Friendly: The single input allows users to search across multiple fields without needing to specify the field.
  • Flexible: This method can be expanded to filter additional nested properties as needed.

Practical Example

Consider a scenario where you want to filter the users based on their city. Typing "Los Angeles" in the filter input will only display Jane's record since it matches the city in the nested address object.

Conclusion

Filtering nested columns in a PrimeNG table can greatly enhance the user experience in applications dealing with complex data structures. By using a unified filtering approach and customizing the filter logic, you can make your Angular application not only functional but also user-friendly.

For further reading and more examples, check out the PrimeNG documentation. This resource offers in-depth insights and additional features of PrimeNG components to expand your application further.

Useful Resources

By implementing these strategies, you can ensure your Angular application provides a robust and flexible data handling experience with PrimeNG tables.