Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A Rails 3 helper for time tags usable for jQuery Timeago plugin.
Ruby
branch: master

This branch is 1 commit ahead, 90 commits behind jgraichen:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
spec
vendor/assets/javascripts
.gitignore
Gemfile
LICENSE
README.md
Rakefile
rails-timeago.gemspec

README.md

rails-timeago

rails-timeago provides a timeago_tag helper to create time tags usable for jQuery Timeago plugin.

Installation

Add this line to your application's Gemfile:

gem 'rails-timeago'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rails-timeago

To use bundled jQuery Timeago plugin add this require statement to your application.js file:

//= require rails-timeago

This will also convert all matching time tags on page load.

Usage

Use the timeago_tag helper like any other regular tag helper:

<%= timeago_tag Time.zone.now, :nojs => true, :limit => 10.days.ago %>

Available options:

nojs Add time ago in words as time tag content instead of absolute time. (default: false)

date_only Only print date as tag content instead of full time. (default: true)

format A time format for localize method used to format static time. (default: default)

limit Set a limit for time ago tags. All dates before given limit will not be converted. (default: 4.days.ago)

force Force time ago tag ignoring limit option. (default: false)

default String that will be returned if time is nil. (default: '-')

All other options will be given as options to the time tag helper. The above options can be assigned globally as defaults using

Rails::Timeago.default_options :limit => proc { 20.days.ago }, :nojs => true

A global limit should always be given as a block that will be evaluated each time the rails timeago_tag helper is called. That avoids the limit becoming smaller the longer the application runs.

I18n

rails-timeago provides additional localization features and includes locale files for the following locales taken from jQuery Timeago.

ar, bg, bs, ca, cy, cz, da, de, el, en, en-short, es, fa, fi, fr, he, hr, hu, hy, id, it, ja, ko, nl, no, pl, pt, ro, ru, sv, tr, uk, uz, zh-CN, zh-TW

rails-timeago will automatically include the locale file for your current locale if it is available. You only have to include the following method into your html head tag:

<%= timeago_script_tag %>

That will add a script include tag to include the needed locale file. rails-timeago will also add all locale files to Rails precompiled assets list to allow precompilation. By default all locale files will be included but you can specify a list by adding a initializer similar to:

Rails::Timeago.locales = [:en, :de, "zh-CN", :sjn]

This will only add English, German, Chinese and Sindarin locale files to precompiled assets. rails-timeago will also only use these locales for locale file lookup for timeago_script_tag. To add your own locales add a file in JavaScript assets directory named locales/jquery.timeago.<locale>.js and add your locale to Rails::Timeago.locales.

rails-timeago provides support for custom locale file mappings. That may be especially useful to override the embedded en locale because there is no English locale file that can be overridden:

Rails::Timeago.map_locale "en", "better/locales/en.js"

Given that mapping rails-timeago's timeago_script_tag will include the mapped locale file into your page.

Note: Rails default application.js file contains a line to require all JavaScript in your assets directory. That will also include all your custom locale files if you place them in app/assets/javascripts/locales and will result in unexpected behavior when using en locale (see #5).

A workaround is to remove the //= require_tree . line from application.js or to move your custom locale files to lib/assets/javascripts/locales.

License

MIT License

Copyright (c) 2012, Jan Graichen

Something went wrong with that request. Please try again.