ubershmekel / jquery-timeago Goto Github PK

View Code? Open in Web Editor NEW

Timeago is a jQuery plugin that makes it easy to support automatically updating fuzzy timestamps (e.g. "4 minutes ago").

License: MIT License

Ruby 0.90% JavaScript 99.10%

jquery-timeago's Introduction

timeago: a jQuery plugin

Timeago is a jQuery plugin that makes it easy to support automatically updating fuzzy timestamps (e.g. "4 minutes ago" or "about 1 day ago") from ISO 8601 formatted dates and times embedded in your HTML (à la microformats).

If you like this project, please help by donating.

Gittip: https://www.gittip.com/rmm5t/
Bitcoin: 1wzBnMjWVZfpiFMc5i2nzKT7sCBaZNfLK

Usage

First, load jQuery and the plugin:

<script src="jquery.min.js" type="text/javascript"></script>
<script src="jquery.timeago.js" type="text/javascript"></script>

Now, let's attach it to your timestamps on DOM ready - put this in the head section:

<script type="text/javascript">
   jQuery(document).ready(function() {
     $("abbr.timeago").timeago();
   });
</script>

This will turn all abbr elements with a class of timeago and an ISO 8601 timestamp in the title (conforming to the datetime design pattern microformat):

<abbr class="timeago" title="2011-12-17T09:24:17Z">December 17, 2011</abbr>

into something like this:

<abbr class="timeago" title="December 17, 2011">about 1 day ago</abbr>

HTML5 <time> elements are also supported:

<time class="timeago" datetime="2011-12-17T09:24:17Z">December 17, 2011</time>

As time passes, the timestamps will automatically update.

For more usage and examples: http://timeago.yarp.com/

For different language configurations: visit the locales directory.

Changes

Version	Notes
1.3.x	(compare) Added updateFromDOM function
1.2.x	(compare) Added cutoff setting
1.1.x	(compare) Added update function
1.0.x	(compare) locale updates; bug fixes; AMD wrapper
0.11.x	(compare) natural rounding; locale updates;
0.10.x	(compare) locale updates
0.9.x	(compare) microsecond support; bug fixes
0.8.x	(compare) `<time>` element support; bug fixes
0.7.x	(compare) locale function overrides; unit tests
...	...