atomic-timeframe-facet (Deprecated)
atomic-timeframe-facet (Deprecated)
A facet is a list of values for a certain field occurring in the results.
An atomic-timeframe-facet
displays a facet of the results for the current query as date intervals.
Introduction
A facet allows users to drill down inside a result set by restricting the result to certain field values. The Timeframe Facet is used specifically with field values that are dates. An optional date picker is available to this facet, allowing users to set custom ranges.
User Experience and Best Practices
-
Users can search for items based on dates, such as: publication date, latest update date, submission date, etc.
-
Enabling the date picker allows users to set a custom date range, helping narrow results to a very specific range.
Properties
Property | Attribute | Description | Type | Default |
---|---|---|---|---|
|
The required facets and values for this facet to be displayed. Examples:
|
|
|
|
|
|
Specifies a unique identifier for the facet. |
|
|
|
|
The field whose values you want to display in the facet. |
|
|
|
|
Whether to exclude the parents of folded results when estimating the result count for each facet value. |
|
|
|
|
The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
Note: A high injectionDepth may negatively impact the facet request performance.
Minimum: |
|
|
|
|
Specifies if the facet is collapsed. |
|
|
|
|
The non-localized label for the facet. Used in the atomic-breadbox component through the bindings store. |
|
|
|
|
Whether this facet should contain an datepicker allowing users to set custom ranges. |
|
|
Shadow Parts
Part | Description |
---|---|
|
The button that resets the actively selected facet values. |
|
The clear button icon. |
|
The wrapper for the entire facet. |
|
The apply button for the custom range. |
|
The input for the ending value of the custom date range. |
|
The label for both the start and end input. |
|
The input for the starting value of the custom date range. |
|
The button that displays the label and allows to expand/collapse the facet. |
|
The label button icon. |
|
The placeholder shown before the first search is executed. |
|
The ripple effect of the component’s interactive elements. |
|
The facet value count, common for all displays. |
|
The facet value label, common for all displays. |
|
The facet value when display is 'link'. |
|
The facet values container. |