Support Menu

Coveo component Sort

Coveo Sort Component (CoveoSort)

The Sort component renders a widget that the end user can interact with to sort query results according to a single criterion or list of criteria.


Component Options


caption: string

Specifies the caption to display on the element.

If you do not specify a value for this option, the component uses the tag body of the element.

Markup configuration example(s) :


sortCriteria: any

Specifies the criterion (or criteria) for sorting.

The possible criteria are:

  • relevancy
  • date
  • qre
  • @fieldname (replace fieldname with an actual field name (e.g., @size)

You can also specify a direction (ascending or descending), for example date ascending.

You can pass an array containing multiple criteria to the Sort component. If you specify multiple criteria, all criteria must have the same direction (either ascending or descending). You can only use the date and @fieldname criteria when specifying multiple criteria. Multiple criteria are evaluated in the order you specify them.

It is necessary to specify a value for this option in order for this component to work.



  • debugInfo(): any


  • disable(): void
  • Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Component are enabled by default on creation.

    Returns void


  • enable(): void
  • Enable the component. Normally this means that the component will execute handlers for the framework events (query events, for example). Components are enabled by default on creation.

    Returns void



  • getCurrentCriteria(): SortCriteria


  • match(sortId: string): unknown


  • select(direction?: string): void
  • Selects the Sort component. Triggers a new query if selecting the component changes the current Sort.options.sortCriteria (if it is toggled).


    • Optional direction: string

      The sort direction. Can be either ascending or descending.

    Returns void

Static get

  • get(element: HTMLElement, componentClass?: any, noThrow?: boolean): BaseComponent
  • Get the bound component to the given HTMLElement. Throws an assert if the HTMLElement has no component bound, unless using the noThrow argument.
    If there is multiple component bound to the current HTMLElement, you must specify the component class.


    • element: HTMLElement

      HTMLElement for which to get the bound component.

    • Optional componentClass: any

      Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.

    • Optional noThrow: boolean

      Boolean option to tell the method to not throw on error.

    Returns BaseComponent



Allows the component to bind events and execute them only when it is enabled.




componentOptionsModel: ComponentOptionsModel

Contains the state of options for differents component. Mainly used by ResultLink.


componentStateModel: ComponentStateModel

Contains the state of different component (enabled vs disabled). Allows to get/set values. Trigger component state event when modified. Each component can listen to those events.


disabled: boolean

A disabled component will not participate in the query, or listen to ComponentEvents.




logger: Logger

Allows component to log in the dev console.


queryController: QueryController

Contains the singleton that allows to trigger queries.


queryStateModel: QueryStateModel

Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.


root: HTMLElement

A reference to the root HTMLElement (the SearchInterface).


searchInterface: SearchInterface

A reference to the root of every component, the SearchInterface.


usageAnalytics: IAnalyticsClient

A reference to the Analytics.client.

Static ID

ID: string

The static ID that each component need to be identified.
For example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton



  • Creates a new Sort component.


    • element: HTMLElement

      The HTMLElement on which to instantiate the component.

    • Optional options: ISortOptions

      The options for the Sort component.

    • Optional bindings: IComponentBindings

      The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).

    Returns Sort