Coveo ResultList Component (CoveoResultList)

Index

Methods

buildResult

buildResults

debugInfo

  • debugInfo(): any

disable

  • disable(): void

displayMoreResults

enable

  • enable(): void

getAutoSelectedFieldsToInclude

  • getAutoSelectedFieldsToInclude(): string[]

getBindings

getDisplayedResults

  • getDisplayedResults(): IQueryResult[]

getDisplayedResultsElements

  • getDisplayedResultsElements(): HTMLElement[]

renderResults

  • renderResults(resultElements: HTMLElement[], append?: boolean): Promise<void>

Static get

  • get(element: HTMLElement, componentClass?: any, noThrow?: boolean): BaseComponent

Properties

bind

componentOptionsModel

componentOptionsModel: ComponentOptionsModel

componentStateModel

componentStateModel: ComponentStateModel

disabled

disabled: boolean

logger

logger: Logger

queryController

queryController: QueryController

queryStateModel

queryStateModel: QueryStateModel

root

root: HTMLElement

searchInterface

searchInterface: SearchInterface

Static ID

ID: string

Accessors

usageAnalytics

usageAnalytics:

Component Options

autoSelectFieldsToInclude

autoSelectFieldsToInclude: boolean
Markup configuration example(s) :
data-auto-select-fields-to-include='true'
data-auto-select-fields-to-include='false'

enableInfiniteScroll

enableInfiniteScroll: boolean
Markup configuration example(s) :
data-enable-infinite-scroll='true'
data-enable-infinite-scroll='false'

enableInfiniteScrollWaitingAnimation

enableInfiniteScrollWaitingAnimation: boolean
Markup configuration example(s) :
data-enable-infinite-scroll-waiting-animation='true'
data-enable-infinite-scroll-waiting-animation='false'

enableScrollToTop

enableScrollToTop: boolean
Markup configuration example(s) :
data-enable-scroll-to-top='true'
data-enable-scroll-to-top='false'

fieldsToInclude

fieldsToInclude: IFieldOption[]

infiniteScrollContainer

infiniteScrollContainer: HTMLElement

infiniteScrollPageSize

infiniteScrollPageSize: number
Markup configuration example(s) :
data-infinite-scroll-page-size='5'

layout

layout: "list" | "card" | "table"
Markup configuration example(s) :
data-layout='card'

resultsContainer

resultsContainer: HTMLElement

waitAnimation

waitAnimation: "fade" | "spinner" | "none"
Markup configuration example(s) :
data-wait-animation='spinner'

waitAnimationContainer

waitAnimationContainer: HTMLElement

Constructors

constructor