Home > widget-integration > FilterOptionsProps

FilterOptionsProps type

Container for all filter options returned by the filter API.

This is the main data structure received from the Boost filter engine, containing all available filters and their current values.

Signature:

export type FilterOptionsProps = {
	filterId: string;
	options: FilterConfig[];
};

References: FilterConfig

Example

const filterOptions: FilterOptionsProps = {
  filterId: 'collection-summer-2024',
  options: [
    {
      filterType: 'price',
      label: 'Price',
      valueType: 'simple',
      values: [{ key: '0-50', label: 'Under $50', doc_count: 42 }]
    }
  ]
};