Coveo Pager Component (CoveoPager)

The Pager component attaches itself to a div element and renders widgets that allow the end user to navigate through the different result pages.

This component takes care of triggering a query with the correct result range whenever the end user selects a page or uses the navigation buttons (Previous and Next).

Index

Methods

Properties

Accessors

Component Options

Constructors

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). Components 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

nextPage

  • nextPage(): void

  • Navigates to the next page, then executes a query.

    Also logs the pageNext event in the usage analytics with the new current page number as meta data.

    Returns void

previousPage

  • previousPage(): void

  • Navigates to the previous page, then executes a query.

    Also logs the pagePrevious event in the usage analytics with the new current page number as meta data.

    Returns void

setPage

  • Sets the current page, then executes a query.

    Also logs an event in the usage analytics (pageNumber by default) with the new current page number as meta data.

    Parameters

    • pageNumber: number

      The page number to navigate to.

    • Default value analyticCause: IAnalyticsActionCause = analyticsActionCauseList.pagerNumber

      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

bind: ComponentEvents

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 different components. Mainly used by ResultLink.

componentStateModel

componentStateModel: ComponentStateModel

Contains the state of different components (enabled vs disabled). Allows to get/set values. Triggers 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.

Static ID

ID: string

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

Accessors

currentPage

  • get (): number

usageAnalytics

Component Options

enableNavigationButton

enableNavigationButton: boolean

Specifies whether the Previous and Next buttons should appear at each end of the pager when appropriate.

The default value is true.

Default

true

Markup configuration example(s) :
data-enable-navigation-button='true'
data-enable-navigation-button='false'

maxNumberOfPages

maxNumberOfPages: number

Specifies the maximum number of pages to display if enough results are available.

This property is typically set when the default number of accessible results from the index has been changed from its default value of 1000 (10 results per page X 100 maxNumberOfPages). Default value is 100

deprecated

This is a deprecated option. The Pager now automatically adapts itself on each new query, so you no longer need to specify a value for this option. However, if the default maximum number of accessible results value was changed on your Coveo index, you should use the maximumNumberOfResultsFromIndex option to specify the new value.

Markup configuration example(s) :
data-max-number-of-pages='10'

maximumNumberOfResultsFromIndex

maximumNumberOfResultsFromIndex: number

Specifies the maximum number of results that the index can return for any query.

Default value is 1000 in a Coveo index.

If this value was modified in your Coveo index, you must specify the new value in this option for the Pager component to work properly

Default

1000

Markup configuration example(s) :
data-maximum-number-of-results-from-index='10'

numberOfPages

numberOfPages: number

Specifies how many page links to display in the pager.

Default value is 5 on a desktop computers and 3 on a mobile device. Minimum value is 1.

Minimum

1

Markup configuration example(s) :
data-number-of-pages='10'

Constructors

constructor