You are reading the documentation for an outdated Corteza release. 2023.9 is the latest stable Corteza release.

Record list filter

The record list filter provides a set of components which allow you to provide flexible record filtering.

All of the logic is contained within the corteza-webapp-compose repository.

Refer to the record list implementation for an example usage.

In future releases, the component may become generalized for different applications.

Structure overview


The components/Common/RecordListFilter.vue file defines the core components of the record list filter feature.

Example usage:
    :selectedField="field.moduleField" (1)
    :namespace="namespace" (2)
    :module="recordListModule" (3)
    :recordListFilter="recordListFilter" (4)
1 the selectedField property defines the default field that should be used when defining filters.
2 the namespace property defines the namespace object we are defining the filter based on.
3 the module property defines the module object we are defining the filter based on.
4 the recordListFilter property defines the filter you wish to show in the given component.


The /src/lib/record-filter.js file defines the logic for converting the output of the RecordListFilter component into a query which can be used with the Corteza server.

Example usage:
import { queryToFilter } from 'corteza-webapp-compose/src/lib/record-filter'