Skip to main contentPrimer

RelativeTime

readyNot reviewed for a11y
Lookbook|Source
This page may be removed. Primer plans to move all Rails component documentation to Lookbook.

Description

Formats a timestamp as a localized string or as relative text that auto-updates in the user's browser.

Arguments

NameRequiredDescription
datetime
Time

The time to be formatted.

tense
Symbol

Which tense to use. One of :auto, :future, or :past.

prefix
String

What to prefix the relative time display with.

second
Symbol

What format seconds should take. One of nil, :numeric, or :two_digit.

minute
Symbol

What format minues should take. One of nil, :numeric, or :two_digit.

hour
Symbol

What format hours should take. One of nil, :numeric, or :two_digit.

weekday
Symbol

What format weekdays should take. One of nil, :long, :narrow, or :short.

day
Symbol

What format days should take. One of nil, :numeric, or :two_digit.

month
Symbol

What format months should take. One of nil, :long, :narrow, :numeric, :short, or :two_digit.

year
Symbol

What format years should take. One of nil, :numeric, or :two_digit.

time_zone_name
Symbol

What format the time zone should take. One of nil, :long, :long_generic, :long_offset, :short, :short_generic, or :short_offset.

threshold
String

The threshold, in ISO-8601 'durations' format, at which relative time displays become absolute.

precision
Symbol

The precision elapsed time should display. One of nil, :day, :hour, :minute, :month, :second, or :year.

format
Symbol

The format the display should take. One of :auto, :elapsed, or :micro.

format_style
Symbol

The format the display should take. One of nil, :long, :narrow, or :short.

lang
String

The language to use.

title
String

Provide a custom title to the element.

no_title
Boolean

Removes the title attribute provided on the element by default.

system_arguments
Hash