The TimespanFacet component displays a FacetRange with prebuilt ranges.
The prebuilt ranges allow you to see the items last updated in the last day, week, month, or year.
This component in a thin wrapper around the standard FacetRange component.
This component is meant to offer out of the box default ranges, so it can easily be inserted in a standard search page.
To configure different ranges than those offered by this component, use the standard FacetRange component instead.
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.
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.
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
Returns the current range the facet uses to query the index
Sets a new range for the component.
Specifies the index field whose values the facet should use.
Default value is the field
Specifies a unique identifier for the facet. Among other things, this identifier serves the purpose of saving the facet state in the URL hash.
If you have two facets with the same field on the same page, you should specify an
id value for at least one of
those two facets. This
id must be unique in the page.
Default value is the
field option value.
Specifies the title to display at the top of the facet.
Default value is the localized string for
The HTMLElement on which to create the component. Used to bind data on the element.
The unique identifier for this component. See: IComponentDefinition.ID. Used to generate the unique Coveo CSS class associated with every component.
The environment for every component. Optional, but omitting to provide one will impact performance.