An auto-updating timeago component for React Native using moment.js
JavaScript
Switch branches/tags
Clone or download
Latest commit 82fa40b Jan 9, 2018

README.md

react-native-timeago

View package on npm npm Build status

An auto-updating timeago component for React Native using moment.js.

Usage

import React, { Component } from 'react';
import TimeAgo from 'react-native-timeago';

// Timestamp can be any valid data type accepted in a Moment.js constructor
// Currently accepts string, number, array, or a Date instance
let timestamp = "2015-06-21T06:24:44.124Z";

class MyComponent extends Component {

  ...

  render() {
    return (
      <TimeAgo time={timestamp} />
    )
  }

  ...
};

If you'd like to hide the string "ago" from the phrase returned, you can use the hideAgo prop:

<TimeAgo time={timestamp} hideAgo={true} />

All normal Text props are applicable (including style). Use the interval prop to change the update interval in milliseconds (default: 60000).

// This component would update every 20 seconds
<TimeAgo time={timestamp} interval={20000} />

Support local language

To support local language, you need to require locale language file, and call moment.locale() in your app. For example

let TimeAgo = require('react-native-timeago');

let moment = require('moment'); //load moment module to set local language
require('moment/locale/zh-cn'); //for import moment local language file during the application build
moment.locale('zh-cn');//set moment local language to zh-cn
...

Contributing

If you'd like to see something added or changed to this module please open a new GitHub issue. Pull requests are always welcome.

Author

Created and maintained by Tyler Hughes. Contributions by these fine folks.

License

Copyright (c) 2015-2018, Tyler Hughes iampbt@gmail.com

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.