Skip to main content

getFilters

Description​

Fetches a list of available filters

Usage​

getFilters(
  type?: "text" | "number" | "date" | "tuple"
): {
  id: string,
  label: string,
  short?: string,
  default?: boolean,
  type: "text" | "number" | "date" | "tuple",
  handler: (a: any, b: any) => boolean,
}[];

Parameters​

  • type - (optional) the filter type to narrow down the results. If omitted, all filters are returned.

Returns​

An array of filter objects matching the given type. If no type is provided, returns all available filters. Each filter object contains:

  • id - (required) - filter operator id, e.g. "notEqual"
  • label - (required) - text label, e.g. "not equal"
  • short - (optional) - short text label, e.g. "!="
  • default - (optional) - defined whether this filter is default for its data type
  • type - (required) filter type ("text", "number", "tuple", "date")
  • handler - (required) comparison function

Example​

The example shows how to output an array of filters to the console:

import { getFilters } from "@svar-ui/react-filter";
// logs all filters
console.log(getFilters());