Date

Use to display the date. Year will not display if it is the current year.

DateTime defaults to the "America/New_York" timezone. Date ignores timezone.

Please note: this kit could potentially change the dates on you!

This is because the Javascript Date class does not have the concept of a date without time. If you pass a Ruby Date string to JavaScript, you will receive a date and a time which makes use of the timezone it infers from your browser based on your virtual geolocation or custom browser settings.

For example, if you pass a date like "7/2/2022" and your browser is on London time, Javascript will convert this to "7/2/2022 at 0:00 BST".

Subsequently, if you have not passed in a timezone to this kit, it will convert that time into US Eastern Time (default), making the resulting date and time "7/1/2022 at 19:00 EST". In this case the expected July 2 date will now be presented as July 1.

Summary

Uses Icons

Default

Apr 16

Aug 2, 2012

Sat

•

Dec 2, 2017

Apr 16

Aug 2, 2012

Sat

•

Dec 2, 2017

<%= pb_rails("date", props: {
  date: Date.today,
  size: "sm"
}) %>

<br>

<%= pb_rails("date", props: {
  date: "2012-08-02T15:49:29Z",
  size: "sm"
}) %>

<br>

<%= pb_rails("date", props: {
  date: "2017-12-02T15:49:29Z",
  show_day_of_week: true,
  size: "sm"
}) %>

<br>
<br>

<%= pb_rails("date", props: {
  date: Date.today,
}) %>

<br>

<%= pb_rails("date", props: {
  date: "2012-08-02T15:49:29Z",
}) %>

<br>

<%= pb_rails("date", props: {
  date: "2017-12-02T15:49:29Z",
  show_day_of_week: true
}) %>

Variants

Apr 15

Wed

•

Apr 15

Wed

•

Apr 15

<div>
  <%= pb_rails("date", props: {
    date: DateTime.now,
    show_icon: true,
    size: "sm"
  }) %>

  <br>

  <%= pb_rails("date", props: {
    date: DateTime.now,
  }) %>

  <br>

  <%= pb_rails("date", props: {
    date: DateTime.now,
    show_icon: true
  }) %>

  <br>

  <%= pb_rails("date", props: {
    date: DateTime.now,
    show_day_of_week: true
  }) %>

  <br>

  <%= pb_rails("date", props: {
    date: DateTime.now,
    show_icon: true,
    show_day_of_week: true
  }) %>
</div>

Alignment

Wed

•

Apr 15

Wed

•

Apr 15

Wed

•

Apr 15

 <%= pb_rails("date", props: {
    date: DateTime.now,
    show_icon: true,
    show_day_of_week: true
  }) %>

  <br><br>

  <%= pb_rails("date", props: {
    date: DateTime.now,
    show_icon: true,
    show_day_of_week: true,
    alignment: "center"
  }) %>

  <br><br>

  <%= pb_rails("date", props: {
    date: DateTime.now,
    show_icon: true,
    show_day_of_week: true,
    alignment: "right"
  }) %>

Timezones

East Coast (Default)

Apr 15

West Coast

Apr 15

Toyko, Japan

Apr 16

Anti-pattern example

Apr 16

Date.today ignores Timezone

DateTime respects Timezone

Apr 16

'.now' in Australia is tomorrow (if you're EST after 10am)

String Dates

Aug 1, 2012

Defaults to UTC, then changes due to EST Timezone.

Depending on the data you send to the date prop you might have unexpected results due to ruby Date and DateTime classes.

Don't care about timezones? Use Date.

If you need a date that recognizes a timezone, especially when paired with the Time kit, leverage DateTime.

<%= pb_rails("caption", props: { text: "East Coast (Default)"}) %>
<%= pb_rails("date", props: {
  date: DateTime.now,
  timezone: "America/New_York"
}) %>

<br>

<%= pb_rails("caption", props: { text: "West Coast"}) %>
<%= pb_rails("date", props: {
  date: DateTime.now,
  timezone: "America/Los_Angeles"
}) %>

<br>

<%= pb_rails("caption", props: { text: "Toyko, Japan"}) %>
<%= pb_rails("date", props: {
  date: DateTime.now,
  timezone: "Asia/Tokyo"
}) %>

<br>

<%= pb_rails("caption", props: { text: "Anti-pattern example"}) %>

<%= pb_rails("date", props: {
  date: Date.today,
  timezone: "Australia/Sydney"
}) %>
<%= pb_rails("body", props: { text: "Date.today ignores Timezone"}) %>

<br>

<%= pb_rails("caption", props: { text: "DateTime respects Timezone"}) %>

<%= pb_rails("date", props: {
  date: DateTime.now,
  timezone: "Australia/Sydney"
}) %>

<%= pb_rails("body", props: { text: "'.now' in Australia is tomorrow (if you're EST after 10am)"}) %>

<br>

<%= pb_rails("caption", props: { text: "String Dates"}) %>
<%= pb_rails("date", props: {
  date: "2012-08-02T00:49:29Z",
}) %>

<%= pb_rails("body", props: { text: "Defaults to UTC, then changes due to EST Timezone."}) %>

Show Current Year

Apr 16, 2026

By default, the Date kit does NOT display the year if it is the current year. If you want to display the current year you can do so by setting showCurrentYear/show_current_year to true as shown here.

<%= pb_rails("date", props: {
  date: Date.today,
  show_current_year: true
}) %>

Unstyled

Example with no year

Apr 16

Example with wrapping typography kit

Aug 2, 2012

Example with icon + subcaption

Thu

•

Aug 2, 2012

For alternative typography styles, you can pass a boolean prop called unstyled to the Date kit and wrap it in any of our typography kits (Title, Body, Caption, etc.). This will allow the Date kit to inherit any of our typography styles.

<%= pb_rails("caption", props: { size: "xs", text: "Example with no year" }) %>

<%= pb_rails("date", props: {
  date: Date.today,
  unstyled: true
}) %>

<br />

<%= pb_rails("caption", props: { size: "xs", text: "Example with wrapping typography kit" }) %>

<%= pb_rails("title", props: { size: 1 }) do %>
  <%= pb_rails("date", props: {
    date: "2012-08-02T15:49:29Z",
    unstyled: true
  }) %>
<% end %>

<br />

<%= pb_rails("caption", props: { size: "xs", text: "Example with icon + subcaption" }) %>

<%= pb_rails("caption", props: { size: "xs" }) do %>
  <%= pb_rails("date", props: {
    date: "2012-08-02T15:49:29Z",
    show_icon: true,
    unstyled: true,
    show_day_of_week: true
  }) %>
<% end %>

Available Props

Props	Type	Values
align_content	enum \| responsive	start end center spaceBetween spaceAround spaceEvenly
align_items	enum \| responsive	start end center
border_radius	enum	none xs sm md lg xl rounded
cursor	enum	auto default none contextMenu help pointer progress wait cell
dark	boolean	true false
flex	enum \| responsive	auto initial 0 1 2 3 4 5 6 7 8 9 10 11 12 none
flex_direction	enum \| responsive	row column rowReverse columnReverse
flex_wrap	enum \| responsive	wrap nowrap wrapReverse
justify_content	enum \| responsive	start end center spaceBetween spaceAround spaceEvenly
line_height	enum	loosest looser loose normal tight tighter tightest
margin_right	array	none xxs xs sm md lg xl
margin_left	array	none xxs xs sm md lg xl
margin_top	array	none xxs xs sm md lg xl
margin_bottom	array	none xxs xs sm md lg xl
margin_x	array	none xxs xs sm md lg xl
margin_y	array	none xxs xs sm md lg xl
margin	array	none xxs xs sm md lg xl
width	string
min_width	string
max_width	string
gap	string \| responsive
column_gap	string \| responsive
row_gap	string \| responsive
number_spacing	enum	tabular
order	enum \| responsive	none first 1 2 3 4 5 6 7 8 9 10 11 12
overflow_x	enum	scroll visible hidden auto
overflow_y	enum	scroll visible hidden auto
overflow	enum	scroll visible hidden auto
padding_right	array	none xxs xs sm md lg xl
padding_left	array	none xxs xs sm md lg xl
padding_top	array	none xxs xs sm md lg xl
padding_bottom	array	none xxs xs sm md lg xl
padding_x	array	none xxs xs sm md lg xl
padding_y	array	none xxs xs sm md lg xl
padding	array	none xxs xs sm md lg xl
position	enum	relative absolute fixed sticky static
shadow	enum	none deep deeper deepest
text_align	enum \| responsive	start end left right center justify justifyAll matchParent
truncate	enum	none 1 2 3 4 5
vertical_align	enum \| responsive	baseline super top middle bottom sub text-top text-bottom
z_index	enum \| responsive	1 2 3 4 5 6 7 8 9 10 max
top	enum \| object	xxs xs sm md lg xl xxl
inset	boolean	true false
right	enum \| object	xxs xs sm md lg xl xxl
bottom	enum \| object	xxs xs sm md lg xl xxl
left	enum \| object	xxs xs sm md lg xl xxl
height	string
max_height	string
min_height	string
hover	object
group_hover	boolean	true false

Props	Type	Values	Default
alignment	"left" \| "center" \| "right"	left center right	left
show_day_of_week	boolean	true false	false
show_current_year	boolean	true false	false
show_icon	boolean	true false	false
size	"sm" \| "md" \| "lg"	lg md sm xs	md
unstyled	boolean	true false	false
value	date
date	string
timezone	string		America/New_York

Contribute to Playbook

When you start designing a new feature, you may come across a Design Token or Component that isn’t defined in Playbook. If so, you should open an issue or reach out to the team to make a contribution.

Contribute on GitHub

As the highest-rated residential remodeler in the nation, our international technology team builds a custom suite of products that continuously transform our business.

Power

Tech @ Power

Open Positions

About Power

Connect

Github

Connect Chat

Date

Aug 2, 2012

Available Props

align_content

align_items

border_radius

cursor

dark

flex

flex_direction

flex_wrap

justify_content

line_height

margin_right

margin_left

margin_top

margin_bottom

margin_x

margin_y

margin

width

min_width

max_width

gap

column_gap

row_gap

number_spacing

order

overflow_x

overflow_y

overflow

padding_right

padding_left

padding_top

padding_bottom

padding_x

padding_y

padding

position

shadow

text_align

truncate

vertical_align

z_index

top

inset

right

bottom

left

height

max_height

min_height

hover

group_hover

alignment

show_day_of_week

show_current_year

show_icon

size

unstyled

value

date

timezone

Contribute to Playbook

Power

Connect