React Ago Component
A multi-lingual component for React that renders the approximate time ago in words from a specific past date using an HTML5 time element.
Features:
- configurable to auto-update its display as time passes by
- supports localized output (with the help of Counterpart and Damals)
Installation
Install via npm:
% npm install react-ago-component
Usage
Just require and render:
var Ago = ;var then = 'Sat Mar 06 1976 04:05:09 GMT+0100 (CET)'; // render component with; // JSX: <Ago date={then} />
This will output something in the likes of
about 38 years ago
The date
prop can be set to a Date object, a number holding the milliseconds since Unix epoch, or to a string (which will be parsed as a Date).
There is also a tooltipFormat
prop to configure the verbosity of the HTML title attribute. Valid values are "short", "long", and "default" (somewhere in-between).
If you want your page to auto-update the visible portion of the rendered HTML element as time passes by, just set the autoUpdate
prop to true
. You can also provide an update interval (in seconds) by setting the prop's value to a natural number greater than 0
.
Localization Support
To localize the rendered output for a locale other than "en" (English), load the corresponding translations and set the locale using Counterpart and Damals:
counterpart;counterpart; counterpart;
When switching locales the Ago component will auto-adjust its output (no page reloading necessary).
Example
The examples code is located at the example
directory. You can clone this repository and run make install example
and point your web browser to
http://localhost:3000
.
Contributing
Here's a quick guide:
-
Fork the repo and
make install
. -
Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate:
make test
. -
Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or are fixing a bug, we need a test!
-
Make the test pass.
-
Push to your fork and submit a pull request.
Licence
Released under The MIT License.