Support Menu

Class LocalStorageHistoryController

This component acts like the HistoryController excepts that is saves the QueryStateModel in the local storage.
This will not allow 'back' and 'forward' navigation in the history, like the standard HistoryController allows. Instead, it load the query state only on page load.
To enable this component, you should set the SearchInterface.options.useLocalStorageForHistory as well as the SearchInterface.options.enableHistory options to true.

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

withoutThoseAttribute

  • withoutThoseAttribute(attributes: string[]): 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