atomic-timeframe-facet

This is for:

Developer

In this article

Properties
Shadow Parts

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.

Properties

Property Attribute Description Type Default

Property	Attribute	Description	Type	Default
`facetId`	`facet-id`	Specifies a unique identifier for the facet.	`string \| undefined`
`field`	`field`	The field whose values you want to display in the facet.	`string`	`'date'`
`filterFacetCount`	`filter-facet-count`	Whether to exclude the parents of folded results when estimating the result count for each facet value.	`boolean`	`true`
`injectionDepth`	`injection-depth`	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: `0`	`number`	`1000`
`isCollapsed`	`is-collapsed`	Specifies if the facet is collapsed.	`boolean`	`false`
`label`	`label`	The non-localized label for the facet.	`string`	`'no-label'`
`withDatePicker`	`with-date-picker`	Whether this facet should contain an datepicker allowing users to set custom ranges.	`boolean`	`false`

facetId

facet-id

Specifies a unique identifier for the facet.

string | undefined

field

The field whose values you want to display in the facet.

string

'date'

filterFacetCount

filter-facet-count

Whether to exclude the parents of folded results when estimating the result count for each facet value.

boolean

true

injectionDepth

injection-depth

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: 0

number

1000

isCollapsed

is-collapsed

Specifies if the facet is collapsed.

boolean

false

label

The non-localized label for the facet.

string

'no-label'

withDatePicker

with-date-picker

Whether this facet should contain an datepicker allowing users to set custom ranges.

boolean

false

Shadow Parts

Part Description

Part	Description
`clear-button`	The button that resets the actively selected facet values.
`clear-button-icon`	The clear button icon.
`facet`	The wrapper for the entire facet.
`input-apply-button`	The apply button for the custom range.
`input-end`	The input for the ending value of the custom date range.
`input-label`	The label for both the start and end input.
`input-start`	The input for the starting value of the custom date range.
`label-button`	The button that displays the label and allows to expand/collapse the facet.
`label-button-icon`	The label button icon.
`placeholder`	The placeholder shown before the first search is executed.
`ripple`	The ripple effect of the component’s interactive elements.
`value-count`	The facet value count, common for all displays.
`value-label`	The facet value label, common for all displays.
`value-link`	The facet value when display is 'link'.
`values`	The facet values container.

clear-button

The button that resets the actively selected facet values.

clear-button-icon

The clear button icon.

facet

The wrapper for the entire facet.

input-apply-button

The apply button for the custom range.

input-end

The input for the ending value of the custom date range.

input-label

The label for both the start and end input.

input-start

The input for the starting value of the custom date range.

label-button

The button that displays the label and allows to expand/collapse the facet.

label-button-icon

The label button icon.

placeholder

The placeholder shown before the first search is executed.

ripple

The ripple effect of the component’s interactive elements.

value-count

The facet value count, common for all displays.

value-label

The facet value label, common for all displays.

value-link

The facet value when display is 'link'.

values

The facet values container.