Home > widget-integration > FilterAPI > addPaginationParams

FilterAPI.addPaginationParams() method

Adds pagination parameters from filter state to API request params.

Extracts the current page number from FilterStore pagination state and includes it in the API request. Override to customize pagination behavior or implement infinite scroll patterns.

Signature:

protected addPaginationParams(params: FilterAPIParams): FilterAPIParams;

Parameters

Returns:

FilterAPIParams

Enhanced parameters with page number added if present in state

Remarks

Page parameter is only added if pagination exists in filter state. Default page is 1 if not specified.

Example

Override to implement infinite scroll:

window.boostWidgetIntegration.extend('FilterAPI', (FilterAPI) => {
  return class CustomFilterAPI extends FilterAPI {
    protected addPaginationParams(params) {
      const enhanced = super.addPaginationParams(params);
      // For infinite scroll, always increment page
      if (this.isInfiniteScrollMode()) {
        enhanced.page = this.getNextPageForInfiniteScroll();
      }
      return enhanced;
    }
  };
});