atomic-timeframe (Deprecated)

This is for:

Developer

In this article

Properties

Atomic v1 has been deprecated. We recommend using the latest version of the Coveo Atomic library.

The atomic-timeframe component defines a timeframe of an atomic-timeframe-facet, and therefore must be defined within an atomic-timeframe-facet component.

A timeframe is a span of time from now to a specific time in the past.

Go to the interactive example

Properties

Property Attribute Description Type Default

Property	Attribute	Description	Type	Default
`amount`	`amount`	The amount of units from which to count. For example: 10 days, 1 year, etc.	`number`	`1`
`label`	`label`	The non-localized label for the timeframe. When defined, it will appear instead of the formatted value. Used in the `atomic-breadbox` component through the bindings store.	`string \| undefined`
`period`	`period`	The relative period of time to now.	`"next" \| "past"`	`'past'`
`unit` (required)	`unit`	The unit used to define: - the start date of the timeframe, if the period is `past` - the end date of the timeframe, if the period is `future`	`"day" \| "hour" \| "minute" \| "month" \| "quarter" \| "week" \| "year"`

amount

The amount of units from which to count.

For example: 10 days, 1 year, etc.

number

1

label

The non-localized label for the timeframe. When defined, it will appear instead of the formatted value. Used in the atomic-breadbox component through the bindings store.

string | undefined

period

The relative period of time to now.

"next" | "past"

'past'

unit (required)

unit

The unit used to define: - the start date of the timeframe, if the period is past - the end date of the timeframe, if the period is future