Home > widget-integration > FilterAPI > applyFilterSettings

FilterAPI.applyFilterSettings() method

Applies filter-specific settings to query parameters.

This method applies shop configuration settings such as sorting behavior, out-of-stock display options, and availability filtering. Override this method to customize filter settings based on shop-specific requirements.

Signature:

protected applyFilterSettings(queryParams: URLSearchParams): void;

Parameters

Returns:

void

Example

Extend to add custom availability filtering:

window.boostWidgetIntegration.extend('FilterAPI', (FilterAPI) => {
  return class CustomFilterAPI extends FilterAPI {
    protected applyFilterSettings(queryParams) {
      super.applyFilterSettings(queryParams);
      // Always hide out of stock for VIP customers
      if (this.customerHasVIPStatus()) {
        queryParams.set('show_out_of_stock', 'false');
      }
    }
  };
});