--- title: "formatRelativeTime" slug: helpers-formatrelativetime category: generic type: documentation version: 20.0.0 tokens: 283 source: https://ovh.github.io/design-system/v20.0.0/llms/helpers-formatrelativetime--documentation.txt --- # formatRelativeTime ## Specifications Format a date to a human readable relative time (like 'a month ago'). | Argument | Type | Default | Description | |---|---|---|---| | `date` | `Date` | - | The date to format. | | `locale` | `string` | 'en-GB' | The locale to use. | | `option` | `RelativeTimeFormatOptions` | - | Language-sensitive formatting options. | - [Intl.RelativeTimeFormatOptions](https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat) ## Examples ### Default ```tsx <>{ formatRelativeTime(new Date()) }> ``` ### Locales ```tsx <>
France: { formatRelativeTime(new Date(), 'fr-FR') }
Germany: { formatRelativeTime(new Date(), 'de-DE') }
Arabic: { formatRelativeTime(new Date(), 'ar-EG') }
India: { formatRelativeTime(new Date(), 'en-IN') }
> ``` ### Format option ```tsx <>Long: { formatRelativeTime(new Date(), 'en-US', { style: 'long'}) }
Short: { formatRelativeTime(new Date(), 'en-US', { style: 'short'}) }
Narrow: { formatRelativeTime(new Date(), 'en-US', { style: 'narrow'}) }
> ```