atomic-timeframe

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.

Properties

Property Attribute Description Type Default

amount

amount

The amount of units from which to count.

E.g., 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.

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"

Recommended Articles