Filter Panel Items

This is the reference for the available object types that can be passed into a <searchcraft-filter-panel>’s items array.

For more information on how Filter Panel works, see the Filtering Search Results page.

Available Items

FacetsFilterItem

Renders a facet index field as list as filterable checkbox view.

{
  fieldName: string;
  type: 'facets';
  options: {
    showSublevel: boolean;
  };
}

NumericFilterItem

Renders a numeric slider component for the specified index field fieldName.

{
  fieldName: string;
  type: 'numericRange';
  options: {
    min: number;
    max: number;
    granularity: number;
  };
}

DateRangeFilterItem

Renders a date range slider component for the specified index field fieldName.

{
  fieldName: string;
  type: 'dateRange';
  options: {
    minDate: Date;
    maxDate?: Date;
    granularity: 'year' | 'month' | 'day' | 'hour';
  };
}

ExactMatchToggleFilterItem

Renders a toggle switch to toggle exact matching on/off.

{
  type: 'exactMatchToggle';
  options: {
    subLabel?: string;
  };
}

MostRecentToggleFilterItem

Renders a toggle switch to toggle the sort by most recent on/off.

{
  fieldName: string;
  type: 'mostRecentToggle';
  options: {
    subLabel?: string;
  };
}