Coveo SearchInterface Component (CoveoSearchInterface)

Index

Methods

attachComponent

debugInfo

  • debugInfo(): any

detachComponent

detachComponentsInside

  • detachComponentsInside(element: HTMLElement): void

disable

  • disable(): void

enable

  • enable(): void

getBindings

  • getBindings(): object

getComponents

  • getComponents<T>(type: string): T[]

getQueryContext

Properties

disabled

disabled: boolean

logger

logger: Logger

responsiveComponents

responsiveComponents: ResponsiveComponents

Static ID

ID: string

Component Options

allowQueriesWithoutKeywords

allowQueriesWithoutKeywords: boolean
Markup configuration example(s) :
data-allow-queries-without-keywords='true'
data-allow-queries-without-keywords='false'

autoTriggerQuery

autoTriggerQuery: boolean
Markup configuration example(s) :
data-auto-trigger-query='true'
data-auto-trigger-query='false'

enableAutomaticResponsiveMode

enableAutomaticResponsiveMode: boolean
Markup configuration example(s) :
data-enable-automatic-responsive-mode='true'
data-enable-automatic-responsive-mode='false'

enableCollaborativeRating

enableCollaborativeRating: boolean
Markup configuration example(s) :
data-enable-collaborative-rating='true'
data-enable-collaborative-rating='false'

enableDebugInfo

enableDebugInfo: boolean
Markup configuration example(s) :
data-enable-debug-info='true'
data-enable-debug-info='false'

enableDuplicateFiltering

enableDuplicateFiltering: boolean
Markup configuration example(s) :
data-enable-duplicate-filtering='true'
data-enable-duplicate-filtering='false'

enableHistory

enableHistory: boolean
Markup configuration example(s) :
data-enable-history='true'
data-enable-history='false'

enableScrollRestoration

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

excerptLength

excerptLength: number
Markup configuration example(s) :
data-excerpt-length='10'

expression

expression: string
Markup configuration example(s) :
data-expression='foo'

filterField

filterField: IFieldOption
Markup configuration example(s) :
data-filter-field='@foo'

firstLoadingAnimation

firstLoadingAnimation: HTMLElement

hideUntilFirstQuery

hideUntilFirstQuery: boolean
Markup configuration example(s) :
data-hide-until-first-query='true'
data-hide-until-first-query='false'

maximumAge

maximumAge: number
Markup configuration example(s) :
data-maximum-age='10'

modalContainer

modalContainer: HTMLElement

pipeline

pipeline: string
Markup configuration example(s) :
data-pipeline='foo'

responsiveMediumBreakpoint

responsiveMediumBreakpoint: number
Markup configuration example(s) :
data-responsive-medium-breakpoint='10'

responsiveMode

responsiveMode: "auto" | "small" | "medium" | "large"

responsiveSmallBreakpoint

responsiveSmallBreakpoint: number
Markup configuration example(s) :
data-responsive-small-breakpoint='10'

resultsPerPage

resultsPerPage: number
Markup configuration example(s) :
data-results-per-page='10'

searchPageUri

searchPageUri: string
Markup configuration example(s) :
data-search-page-uri='foo'

timezone

timezone: string
Markup configuration example(s) :
data-timezone='foo'

useLocalStorageForHistory

useLocalStorageForHistory: boolean
Markup configuration example(s) :
data-use-local-storage-for-history='true'
data-use-local-storage-for-history='false'

Constructors

constructor

  • new SearchInterface(element: HTMLElement, options?: ISearchInterfaceOptions, analyticsOptions?: any, _window?: Window): SearchInterface

Implements