Skip to content

DateRangeDisplay ​

Overview ​

Displays a formatted date range from a start and end value (ISO strings or Luxon DateTimes). Renders a single date when both values fall on the same day, and omits redundant year or month segments when the range stays within the same month or year.

Theme entry: DateRangeDisplay

Props ​

NameTypeRequiredDefaultDescription
themeOverrideObjectnullA partial ThemeObject keyed by component name, merged over this component's theme and provided to descendants.
startstring|objectyesStart of the date range as an ISO string or Luxon DateTime.
endstring|objectyesEnd of the date range as an ISO string or Luxon DateTime.
showTimebooleanfalseWhether to include the time when both dates fall on the same day.
localestring"en-CA"BCP 47 locale tag used to format the displayed date segments.

Source ​

client/lib/display/date-display/DateRangeDisplay.vue