The Breadcrumb component displays a summary of the currently active query filters.
For example, when the user selects a Facet value, the breadcrumbs display this value.
The active filters are obtained by the component by firing an event in the Breadcrumb component.
All other components having an active state can react to this event by providing custom bits of HTML to display inside the breadcrumbs.
Thus, it is possible to easily extend the Breadcrumb component using custom code to display information about custom states and filters.
See BreadcrumbEvents for the list of events and parameters sent when a Breadcrumb component is populated.
Triggers the event to clear the current breadcrumbs that components such as Facet can populate.
Also triggers a new query and logs the
breadcrumbResetAll event in the usage analytics.
Return the debug info about this component.
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.
Draws the specified breadcrumb items.
The breadcrumb items to draw.
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.
Return the bindings, or environment, for the current component.
Triggers the event to populate the breadcrumbs. Components such as Facet can populate the breadcrumbs.
A populated breadcrumb item list.
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.
HTMLElement for which to get the bound component.
Optional component class. If the HTMLElement has multiple components bound, you must specify which one you are targeting.
Boolean option to tell the method to not throw on error.
Allows the component to bind events and execute them only when it is enabled.
Contains the state of options for different components. Mainly used by ResultLink.
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.
A disabled component will not participate in the query, or listen to ComponentEvents.
Allows component to log in the dev console.
Contains the singleton that allows to trigger queries.
Contains the state of the query. Allows to get/set values. Trigger query state event when modified. Each component can listen to those events.
A reference to the root HTMLElement (the SearchInterface).
A reference to the root of every component, the SearchInterface.
The static ID that each component needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
The heading level to use for the heading before the breadcrumbs.
A value of 0 will render a
div element instead.
Creates a new Breadcrumb component. Binds event on QueryEvents.deferredQuerySuccess to draw the breadcrumbs.
The HTMLElement on which to instantiate the component.
The options for the Breadcrumb component.
The bindings that the component requires to function normally. If not set, these will be automatically resolved (with a slower execution time).