Support Menu

Coveo component ResultsPerPage

Coveo ResultsPerPage Component (CoveoResultsPerPage)

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.

Index

Component Options

choicesDisplayed

choicesDisplayed: Array<number>

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].

Markup configuration example(s) :
data-choices-displayed='10,102'

initialChoice

initialChoice: number

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.

Markup configuration example(s) :
data-initial-choice='10'

Methods

debugInfo

  • debugInfo(): any

disable

  • 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

  • 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

getBindings

setResultsPerPage

  • 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.

    Parameters

    • resultsPerPage: number

      The new number of results per page to select.

    • Default value analyticCause: IAnalyticsActionCause = analyticsActionCauseList.pagerResize

      The event to log in the usage analytics.

    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.

    Parameters

    • 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

Properties

bind

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

type

{Coveo.ComponentEvents}

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

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

componentStateModel

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

disabled: boolean

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

type

{boolean}

logger

logger: Logger

Allows component to log in the dev console.

queryController

queryController: QueryController

Contains the singleton that allows to trigger queries.

queryStateModel

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

root: HTMLElement

A reference to the root HTMLElement (the SearchInterface).

searchInterface

searchInterface: SearchInterface

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

usageAnalytics

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

Constructors

constructor

  • Creates a new ResultsPerPage. The component renders itself on every query success.

    Parameters

    • element: HTMLElement

      The HTMLElement on which to instantiate the component (normally a div).

    • Optional options: IResultsPerPageOptions

      The options for the ResultsPerPage 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 ResultsPerPage