LocalTime

Alpha

View source View storybook

On this page

Arguments
Examples

This component requires JavaScript to function. Please refer to the Installation section to set it up.

Use LocalTime to format a date and time in the user's preferred locale format. This component requires JavaScript.

Arguments

Name	Type	Default	Description
`datetime`	`DateTime`	N/A	The date to parse
`initial_text`	`String`	`nil`	Text to render before component is initialized
`weekday`	`Symbol`	`:short`	One of `:long` and `:short`.
`year`	`Symbol`	`:numeric`	One of `:2-digit` and `:numeric`.
`month`	`Symbol`	`:short`	One of `:long` and `:short`.
`day`	`Symbol`	`:numeric`	One of `:2-digit` and `:numeric`.
`hour`	`Symbol`	`:numeric`	One of `:2-digit` and `:numeric`.
`minute`	`Symbol`	`:numeric`	One of `:2-digit` and `:numeric`.
`second`	`Symbol`	`:numeric`	One of `:2-digit` and `:numeric`.
`time_zone_name`	`Symbol`	`:short`	One of `:long` and `:short`.
`system_arguments`	`Hash`	N/A	System arguments

Examples

Default

June 1, 2014 13:05 +00:00

<%= render(Primer::LocalTime.new(datetime: DateTime.parse("2014-06-01T13:05:07Z"))) %>

All the options

June 1, 2014 13:05 +00:00

<%= render(Primer::LocalTime.new(datetime: DateTime.parse("2014-06-01T13:05:07Z"), weekday: :long, year: :"2-digit", month: :long, day: :"2-digit", hour: :"2-digit", minute: :"2-digit", second: :"2-digit", time_zone_name: :long)) %>

With initial content

June 1, 2014 13:05 +00:00

<%= render(Primer::LocalTime.new(datetime: DateTime.parse("2014-06-01T13:05:07Z"))) do %>
  <!-- This content will be replaced once the component connects -->
  2014/06/01 13:05
<% end %>

Edit this page on GitHub