Filters

Filters library is used to manipulate filters in model list for component.

Example in editor:

filters.filter = 'Hello world';
filters.dateFrom = '2023-12-06'
  • filter var
    • Keyword for search ex: filters.filter = 'Hello world'
  • dateField var
    • Available date fields from date field dropdown, default fields are Created At and Updated At, other custom fields are presented that are created by user ex: filters.dateField = 'created_at'
  • dateFrom var
    • Set range of date from ex: filters.dateFrom = 'moment().format("YYYY-MM-DD")'
  • dateTo var
    • Set range of date to ex: filters.dateFrom = 'moment().format("YYYY-MM-DD")'
  • setAdvFilters(filters = {}) method
    • Set advanced filters for list. The object passed follows the same query operator syntax used in component find() and $adv filters. Every time the list is loaded the advanced filters expression is re-evaluated and new values are potentially set.
    • Date comparisons: Both plain date strings and $date casting are supported. Plain date strings are automatically converted to proper dates: 
      // Both forms work:
filters.setAdvFilters({ updated_at: { $lt: "2025-01-01" } })
filters.setAdvFilters({ updated_at: { $lt: { $date: "2025-01-01" } } })
  • setFilterOn(fields = ['']) method
    • Set on which fields filter variable will be applied. ex: filters.setFilterOn(['first_name', 'email'])