react-timeago-i18n
TypeScript icon, indicating that this package has built-in type declarations

2.2.1 ā€¢ Public ā€¢ Published

react-timeago-i18n

build npm version npm bundle size

šŸ“…šŸŒ A tiny relative time component for react, which uses the browser's native Intl.RelativeTimeFormat API. This means that all languages are supported without bundling translations.

This library is 0.8 kB, which is significantly smaller than react-timeago which is 96 kB.

Install

npm install react-timeago-i18n

Usage

import TimeAgo from "react-timeago-i18n";

<TimeAgo date="2019-07-16" /> // --> "4 years ago"
<TimeAgo date="2019-07-16" locale="de-AT" /> // --> "vor 4 Jahren"

Props

Property Description Default Value
date string or Date -
locale the language to use navigator.language
formatOptions options for Intl.RelativeTimeFormat undefined
allowFuture By default, only dates in the past are supported. If you want to display future dates (i.e. "in 3 days") set this property to true false
hideSeconds By default, values smaller than 1 minute will shown as "1 minute" instead of frequently updating seconds, unless you set this property to false. true
hideSecondsText When using hideSeconds, seconds are displayed as "1 minute ago" or "in 1 minute", use this property to provide custom strings i.e. ["just now", "right now"] []
roundStrategy By default, values are rounded (e.g. 11.9 months becomes "2 years"). If this is not desired, the rounding strategy can be changed to floor. "round"
timeElement By default, the result is wrapped in <time title="..."> ... </time>, unless you set this property to false true

Context Provider

Options can be specified as props, or using a context provider.

For example:

import TimeAgo, { TimeAgoProvider } from "react-timeago-i18n";

<TimeAgoProvider locale="zh-Hans" hideSeconds>
  ...
  <TimeAgo date="2019-07-16" />
  ...
</TimeAgoProvider>;

Package Sidebar

Install

npm i react-timeago-i18n

Weekly Downloads

300

Version

2.2.1

License

MIT

Unpacked Size

17.9 kB

Total Files

9

Last publish

Collaborators

  • kyle.h