PaginationActions

Coveo Relevance Cloud Developer Headless Product Documentation

The pagination action creators.

See Dispatch Actions.

Loader Function

loadPaginationActions

Loads the pagination reducer and returns possible action creators.

Parameters

  • engine: CoreEngine

    The headless engine.

Returns PaginationActionCreators: The pagination action creators.

PaginationActionCreators

nextPage

Updates the page to the next page.

Returns PayloadAction: A dispatchable action.

previousPage

Updates the page to the previous page.

Returns PayloadAction: A dispatchable action.

registerNumberOfResults

Initializes the numberOfResults query parameter. For more information, refer to the documentation on query parameters.

Parameters

  • numberOfResults: number

    The initial number of results.

Returns PayloadAction<number>: A dispatchable action.

registerPage

Sets the initial page by initializing the firstResult query parameter. For more information, refer to the documentation on query parameters.

Parameters

  • page: number

    The initial page number.

Returns PayloadAction<number>: A dispatchable action.

updateNumberOfResults

Updates the numberOfResults query parameter. For more information, refer to the documentation on query parameters.

Parameters

  • numberOfResults: number

    The new number of results.

Returns PayloadAction<number>: A dispatchable action.

updatePage

Updates the page by updating the firstResult query parameter. For more information, refer to the documentation on query parameters.

Parameters

  • page: number

    The new page number.

Returns PayloadAction<number>: A dispatchable action.