SortCriteriaActions (Deprecated)

This is for:

Developer
Warning

Headless v1 has been deprecated. We recommend using the latest version of the Coveo Headless library.

The sort criteria action creators.

See Dispatch Actions.

Loader Function

loadSortCriteriaActions

Loads the sortCriteria reducer and returns possible action creators.

Parameters

  • engine: SearchEngine

    The headless engine.

Returns SortCriteriaActionCreators: The sort criteria action creators.

SortCriteriaActionCreators

registerSortCriterion

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

Parameters

  • criterion: SortByRelevancy | SortByQRE | SortByDate | SortByField | SortByNoSort

    The initial sort criterion.

Returns PayloadAction<SortCriterion | SortCriterion[]>: A dispatchable action.

updateSortCriterion

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

Parameters

  • criterion: SortByRelevancy | SortByQRE | SortByDate | SortByField | SortByNoSort

    The sort criterion to set.

Returns PayloadAction<SortCriterion | SortCriterion[]>: A dispatchable action.