Support Menu

Class HistoryController

This component is instantiated automatically by the framework on the root if the SearchInterface.
When the SearchInterface.options.enableHistory option is set to true, this component is instantiated.
It's only job is to apply changes in the QueryStateModel to the hash in the URL, and vice versa.
This component does not hold the state of the interface, it only represent it in the URL.

Index

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

setHashValues

  • setHashValues(values: object): void

Properties

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.

Static ID

ID: string

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

Constructors

constructor

Hierarchy

  • RootComponent