Relative Date Time

The lightning:relativeDateTime component displays relative time that shows how much time has passed or how much time is left until a given date/time. It formats the relative time for the current locale following the rules from Unicode CLDR.

Use the value attribute to pass the date to format. When you provide a timestamp or JavaScript Date object, lightning:relativeDateTime displays a string that describes the relative time between the current time and the provided time.

The unit of time that's displayed depends on how much time has passed since the provided time, for example, "a few seconds ago" or "5 minutes ago". A given time in the future returns the relative time, for example, "in 7 months" or "in 5 years".

This example returns the relative time between the current time and a given time in the past and future. The time values are set by the init handler.

The client-side controller is called during component initialization. The past and future attributes return:

• 2 hours ago
• in 2 days

Other sample output includes:

• Relative past: a few seconds ago, a minute ago, 2 minutes ago, an hour ago, 2 hours ago, 2 days ago, 2 months ago, 2 years ago
• Relative future: in a few seconds, in a minute, in 2 minutes, in an hour, in 2 hours, in 2 days, in 2 months, in 2 years in 2 days, in 2 months

The user's language setting in an org determines the language displayed for the units of time. If the locale uses a different language, the output uses the language setting and ignores the locale. For example, if you set the locale to Arabic and the language to English, the output uses digits 0-9 for numbers and English instead of Arabic numerals to be consistent with the language on the user interface. For more information, see Supported Languages.

Units of time include:

• seconds
• minutes
• hours
• days
• months
• years

To obtain the language and locale information in your org, use the $Locale global value provider. For more information, see $Locale.