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.

See this kit in action in our sample UI

Default

Apr 26

Aug 2, 2012

Sat

•

Dec 2, 2017

Apr 26

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 25

Thu

•

Apr 25

Thu

•

Apr 25

<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

Thu

•

Apr 25

Thu

•

Apr 25

Thu

•

Apr 25

 <%= 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 25

West Coast

Apr 25

Toyko, Japan

Apr 26

Anti-pattern example

Apr 26

Date.today ignores Timezone

DateTime respects Timezone

Apr 26

'.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."}) %>

Unstyled

Example with no year

Apr 26

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 %>

UI Samples using Date Kit

Get the full picture. See how this kit is used in our samples.

Crm Client List

Available Props

Props	Type	Values
max_width	array	xs sm md lg xl xxl 0 none
z_index	array	1 2 3 4 5 6 7 8 9 10
number_spacing	array	tabular
shadow	array	none deep deeper deepest
line_height	array	tightest tighter tight normal loose looser loosest
display	array	block inline_block inline flex inline_flex none
cursor	array	auto default none contextMenu help pointer progress wait cell crosshair text verticalText alias copy move noDrop notAllowed grab grabbing eResize nResize neResize nwResize sResize seResize swResize wResize ewResize nsResize neswResize nwseResize colResize rowResize allScroll zoomIn zoomOut
flex_direction	array	row column rowReverse columnReverse
flex_wrap	array	wrap nowrap wrapReverse
justify_content	array	start end center spaceBetween spaceAround spaceEvenly
justify_self	array	auto start end center stretch
align_items	array	flexStart flexEnd start end center baseline stretch
align_content	array	start end center spaceBetween spaceAround spaceEvenly
align_self	array	auto start end center stretch baseline
flex	array	auto initial 0 1 2 3 4 5 6 7 8 9 10 11 12 none
flex_grow	array	1 0
flex_shrink	array	1 0
order	array	1 2 3 4 5 6 7 8 9 10 11 12
position	array	relative absolute fixed sticky
hover	array
border_radius	array	none xs sm md lg xl rounded
text_align	array	start end left right center justify justify-all match-parent
overflow	array	visible hidden scroll auto
truncate	array	1 2 3 4 5
left	array	0 xxs xs sm md lg xl auto initial inherit
top	array	0 xxs xs sm md lg xl auto initial inherit
right	array	0 xxs xs sm md lg xl auto initial inherit
bottom	array	0 xxs xs sm md lg xl auto initial inherit
overflow_x	array	visible hidden scroll auto
overflow_y	array	visible hidden scroll auto
margin	array	none xxs xs sm md lg xl
margin_bottom	array	none xxs xs sm md lg xl
margin_left	array	none xxs xs sm md lg xl
margin_right	array	none xxs xs sm md lg xl
margin_top	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
padding	array	none xxs xs sm md lg xl
padding_bottom	array	none xxs xs sm md lg xl
padding_left	array	none xxs xs sm md lg xl
padding_right	array	none xxs xs sm md lg xl
padding_top	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
classname	string
dark	boolean
id	string
data	hashprop
aria	hashprop
html_options	hashprop
children	proc

Props	Type	Values	Default
date	string
alignment	enum	left center right	left
show_icon	boolean		false
show_day_of_week	boolean		false
size	enum	lg md sm xs	md
timezone	string		America/New_York
unstyled	boolean		false

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

Dribbble

Github

Connect Chat

Date

See this kit in action in our sample UI

Aug 2, 2012

UI Samples using Date Kit

Crm Client List

Available Props

max_width

z_index

number_spacing

shadow

line_height

display

cursor

flex_direction

flex_wrap

justify_content

justify_self

align_items

align_content

align_self

flex

flex_grow

flex_shrink

order

position

hover

border_radius

text_align

overflow

truncate

left

top

right

bottom

overflow_x

overflow_y

margin

margin_bottom

margin_left

margin_right

margin_top

margin_x

margin_y

padding

padding_bottom

padding_left

padding_right

padding_top

padding_x

padding_y

classname

dark

id

data

aria

html_options

children

date

alignment

show_icon

show_day_of_week

size

timezone

unstyled

Contribute to Playbook

Power

Connect