The ResultsPerPage component attaches itself to a
div and allows the end user to choose how many results to
display per page.
Note: Adding a ResultPerPage component to your page overrides the value of SearchInterface.options.resultsPerPage.
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.
Sets the current number of results per page, then executes a query.
Also logs an event in the usage analytics (
pagerResize by default) with the new current number of results per
page as meta data.
The new number of results per page to select.
The event to log in the usage analytics.
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
Specifies the possible values of number of results to display per page that the end user can select from.
See also ResultsPerPage.options.initialChoice.
Default value is
[10, 25, 50, 100].
Specifies the value to select by default for the number of results to display per page.
Default value is the first value of ResultsPerPage.options.choicesDisplayed.
Creates a new ResultsPerPage. The component renders itself on every query success.
The HTMLElement on which to instantiate the component (normally a
The options for the ResultsPerPage component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).