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.
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.
Specifies the criterion (or criteria) for sorting.
The possible criteria are:
fieldnamewith an actual field name (e.g.,
You can also specify a direction (
descending), for example
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
You can only use the
@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.
Return the debug info about this component.
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.
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.
Return the bindings, or environment, for the current component.
Gets the current Sort.options.sortCriteria.
Indicates whether the name of any of the Sort.options.sortCriteria matches the argument.
The sort criteria name to look for (e.g.,
Selects the Sort component. Triggers a new query if selecting the component changes the current Sort.options.sortCriteria (if it is toggled).
The sort direction. Can be either
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.
HTMLElement for which to get the bound component.
Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.
Boolean option to tell the method to not throw on error.
Allows the component to bind events and execute them only when it is enabled.
Contains the state of options for differents component. Mainly used by ResultLink.
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.
A disabled component will not participate in the query, or listen to ComponentEvents.
Allows component to log in the dev console.
Contains the singleton that allows to trigger queries.
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
A reference to the root HTMLElement (the SearchInterface).
A reference to the root of every component, the SearchInterface.
A reference to the Analytics.client.
The static ID that each component need to be identified.
For example, SearchButton -> static ID : SearchButton -> className : CoveoSearchButton
Creates a new Sort component.
The HTMLElement on which to instantiate the component.
The options for the Sort component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).