relative-timestamp
v1.0.0
Published
DESCRIPTION
Downloads
43
Readme
RelativeTimestamp
RelativeTimestamp
is a React component for formatting Unix timestamps in
relative time, e.g. Now
, 12 days ago
, or 1 year ago
.
Install
npm install relative-timestamp
oryarn add relative-timestamp
Use
import RelativeTimestamp from 'relative-timestamp';
const MY_DATE = new Date(2000, 4, 20);
const MY_TIMESTAMP = MY_DATE.getTime();
// In the year 2021, this will output "21 years ago."
function MyRelativeTimestamp() {
return <RelativeTimestamp value={MY_TIMESTAMP} />;
}
Supported time units
The RelativeTimestamp
component supports now, minutes, hours, days, months,
and years.
Seconds are not supported and are instead represented as Now. Rendering timestamps from seconds ago would be too noisy to animate and have too poor of performance to re-render every second. Instead of "X seconds ago" ticking up every second, the component instead renders "Now" and re-renders on the minute mark.
API
children
Type: (unit, count) => ReactNode
(optional)
If you want to provide custom internationalization, logic, or styling on your
display, you can optionally pass a children
prop that accepts the unit and
count.
For example,
const MY_DATE = new Date(2000, 4, 20);
const MY_TIMESTAMP = MY_DATE.getTime();
function MyRelativeTimestamp() {
return (
<RelativeTimestamp value={MY_TIMESTAMP}>
{(unit, count) => {
switch (unit) {
case 'now':
return <I18n>now</I18n>;
case 'days':
case 'hours':
case 'minutes':
case 'months':
case 'years':
return <I18n count={count}>{unit}_ago</I18n>;
}
}}
</RelativeTimestamp>
);
}
value
Type: number
(required)
The value
prop should be the Unix timestamp that you want to display
relatively.
Contributing
yarn set version latest
yarn up * @*/*
yarn add --dev @yarnpkg/pnpify
yarn pnpify --sdk vscode