playbook_ui 15.1.0.pre.rc.4 → 15.1.0.pre.rc.5

data/app/pb_kits/playbook/pb_timestamp/_timestamp.tsx

@@ -18,9 +18,11 @@ type TimestampProps = {
   timezone: string,
   htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string,
+  showCurrentYear?: boolean,
   showDate?: boolean,
   showUser?: boolean,
   hideUpdated?: boolean,
+  showTime?: boolean,
   showTimezone?: boolean,
   unstyled?: boolean,
   variant?: "default" | "elapsed" | "updated"
@@ -37,9 +39,11 @@ const Timestamp = (props: TimestampProps): React.ReactElement => {
     text,
     timezone,
     timestamp,
+    showCurrentYear = false,
     showDate = true,
     showUser = false,
     hideUpdated = false,
+    showTime = true,
     showTimezone = false,
     unstyled = false,
     variant = 'default',
@@ -55,7 +59,6 @@ const Timestamp = (props: TimestampProps): React.ReactElement => {
   )
 
   const currentYear = new Date().getFullYear().toString()
-  const dateDisplay = `${DateTime.toMonth(timestamp, timezone)} ${DateTime.toDay(timestamp, timezone)}`
   const shouldShowUser = showUser == true && text.length > 0
   const shouldShowTimezone = showTimezone == true && timezone.length > 0
   const updatedText = hideUpdated ? "" : "Last updated"
@@ -70,16 +73,26 @@ const Timestamp = (props: TimestampProps): React.ReactElement => {
     return timeDisplay
   }
 
+  const baseDateDisplay = () => {
+  let display = `${DateTime.toMonth(timestamp, timezone)} ${DateTime.toDay(timestamp, timezone)}`
+  if (DateTime.toYear(timestamp, timezone).toString() !== currentYear || showCurrentYear) {
+    display = `${display}, ${DateTime.toYear(timestamp, timezone)}`
+  }
+  return display
+}
+
   const fullDateDisplay = () => {
-    let fullDisplay = `${DateTime.toMonth(timestamp, timezone)} ${DateTime.toDay(timestamp, timezone)}`
-    if (DateTime.toYear(timestamp, timezone).toString() !== currentYear) {
-      fullDisplay = `${fullDisplay}, ${DateTime.toYear(timestamp, timezone)}`
-    }
-    return `${fullDisplay} ${' \u00b7 '} ${fullTimeDisplay()}`
+    const fullDisplay = baseDateDisplay()
+    return showTime ? `${fullDisplay} ${' \u00b7 '} ${fullTimeDisplay()}` : fullDisplay
   }
 
   const formatUpdatedString = () => {
-    return `Last updated ${userDisplay} on ${dateDisplay} at ${timeDisplay}`
+    const finalUpdatedString = []
+    if (shouldShowUser) finalUpdatedString.push(`by ${text}`)
+    if (showDate && !showTime) finalUpdatedString.push(`on ${baseDateDisplay()}`)
+    if (showDate && showTime) finalUpdatedString.push(`on ${baseDateDisplay()} at ${timeDisplay}`)
+    if (showTime && !showDate) finalUpdatedString.push(`at ${timeDisplay}`)
+    return `Last updated ${finalUpdatedString.join(' ')}`
   }
 
   const formatElapsedString = () => {
@@ -93,7 +106,10 @@ const Timestamp = (props: TimestampProps): React.ReactElement => {
     case 'elapsed':
       return formatElapsedString()
     default:
-      return showDate ? timestamp ? fullDateDisplay() : text : fullTimeDisplay()
+      if (showDate && showTime) return timestamp ? fullDateDisplay() : text
+      if (showDate && !showTime) return baseDateDisplay()
+      if (!showDate && showTime) return fullTimeDisplay()
+      return text
     }
   }
 

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_align.html.erb

@@ -8,7 +8,6 @@
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now,
-  show_date: true,
   align: "left"
 }) %>
 
@@ -16,7 +15,6 @@
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now + 4.years,
-  show_date: true,
   align: "left"
 }) %>
 
@@ -24,7 +22,6 @@
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now - 1.year,
-  show_date: true,
   align: "left"
 }) %>
 
@@ -40,7 +37,6 @@
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now,
-  show_date: true,
   align: "center"
 }) %>
 
@@ -48,7 +44,6 @@
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now + 4.years,
-  show_date: true,
   align: "center"
 }) %>
 
@@ -56,7 +51,6 @@
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now - 1.year,
-  show_date: true,
   align: "center"
 }) %>
 
@@ -64,7 +58,6 @@
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now,
-  show_date: false,
   align: "right"
 }) %>
 
@@ -72,7 +65,6 @@
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now,
-  show_date: true,
   align: "right"
 }) %>
 
@@ -80,7 +72,6 @@
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now + 4.years,
-  show_date: true,
   align: "right"
 }) %>
 
@@ -88,6 +79,5 @@
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now - 1.year,
-  show_date: true,
   align: "right"
 }) %>

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_align.jsx

@@ -25,7 +25,6 @@ const TimestampAlign = (props) => {
 
       <Timestamp
           align="left"
-          showDate
           timestamp={todaysDate}
           {...props}
       />
@@ -34,7 +33,6 @@ const TimestampAlign = (props) => {
 
       <Timestamp
           align="left"
-          showDate
           timestamp={futureDate}
           {...props}
       />
@@ -43,7 +41,6 @@ const TimestampAlign = (props) => {
 
       <Timestamp
           align="left"
-          showDate
           timestamp={pastDate}
           {...props}
       />
@@ -62,7 +59,6 @@ const TimestampAlign = (props) => {
 
       <Timestamp
           align="center"
-          showDate
           timestamp={todaysDate}
           {...props}
       />
@@ -71,7 +67,6 @@ const TimestampAlign = (props) => {
 
       <Timestamp
           align="center"
-          showDate
           timestamp={futureDate}
           {...props}
       />
@@ -80,7 +75,6 @@ const TimestampAlign = (props) => {
 
       <Timestamp
           align="center"
-          showDate
           timestamp={pastDate}
           {...props}
       />
@@ -99,7 +93,6 @@ const TimestampAlign = (props) => {
 
       <Timestamp
           align="right"
-          showDate
           timestamp={todaysDate}
           {...props}
       />
@@ -108,7 +101,6 @@ const TimestampAlign = (props) => {
 
       <Timestamp
           align="right"
-          showDate
           timestamp={futureDate}
           {...props}
       />
@@ -117,7 +109,6 @@ const TimestampAlign = (props) => {
 
       <Timestamp
           align="right"
-          showDate
           timestamp={pastDate}
           {...props}
       />

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_align.md

@@ -0,0 +1 @@
+The `align` prop can be used to set alignment. This prop is set to 'left' by default. 

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_default.html.erb

@@ -1,29 +1,15 @@
 <%= pb_rails("timestamp", props: {
-  timestamp: DateTime.now,
-  show_date: false,
-  align: "left"
+  timestamp: DateTime.now
 }) %>
 
 <br>
 
 <%= pb_rails("timestamp", props: {
-  timestamp: DateTime.now,
-  show_date: true,
-  align: "left"
+  timestamp: DateTime.now + 4.years
 }) %>
 
 <br>
 
 <%= pb_rails("timestamp", props: {
-  timestamp: DateTime.now + 4.years,
-  show_date: true,
-  align: "left"
-}) %>
-
-<br>
-
-<%= pb_rails("timestamp", props: {
-  timestamp: DateTime.now - 1.year,
-  show_date: true,
-  align: "left"
+  timestamp: DateTime.now - 1.year
 }) %>

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_default.jsx

@@ -15,8 +15,6 @@ const TimestampDefault = (props) => {
   return (
     <div>
       <Timestamp
-          align="left"
-          showDate={false}
           timestamp={todaysDate}
           {...props}
       />
@@ -24,17 +22,6 @@ const TimestampDefault = (props) => {
       <br />
 
       <Timestamp
-          align="left"
-          showDate
-          timestamp={todaysDate}
-          {...props}
-      />
-
-      <br />
-
-      <Timestamp
-          align="left"
-          showDate
           timestamp={futureDate}
           {...props}
       />
@@ -42,8 +29,6 @@ const TimestampDefault = (props) => {
       <br />
 
       <Timestamp
-          align="left"
-          showDate
           timestamp={pastDate}
           {...props}
       />

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_default.md

@@ -0,0 +1 @@
+By default, the timestamp kit will display the date and time as shown here. If the date is NOT within the current year, the year will also be shown while dates in the current year will not show the year. 

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_elapsed.html.erb

@@ -10,7 +10,6 @@
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now - 3.months,
   variant: "elapsed",
-  show_user: false
 }) %>
 
 <br>
@@ -18,6 +17,5 @@
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now - 320.days,
   variant: "elapsed",
-  show_user: false,
   hide_updated: true
 }) %>

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_elapsed.jsx

@@ -23,7 +23,6 @@ const TimestampElapsed = (props) => {
       <br />
 
       <Timestamp
-          showUser={false}
           timestamp={customDate}
           variant="elapsed"
           {...props}
@@ -33,7 +32,6 @@ const TimestampElapsed = (props) => {
 
       <Timestamp
           hideUpdated
-          showUser={false}
           timestamp={customDate}
           variant="elapsed"
           {...props}

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_elapsed.md

@@ -0,0 +1,5 @@
+Use variant `elapsed` to show time ago. This variant can be customized in several ways:
+
+Use the optional `showUser`/`show_user` prop to show user as part of the text. When showing the user, pass in the user name using the `text` prop as shown. `showUser`/`show_user` is set to false by default. 
+
+Use the optional `hideUpdated`/`hide_updated` prop to hide the 'Last updated' text if needed. 

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_show_current_year.html.erb

@@ -0,0 +1,12 @@
+<%= pb_rails("timestamp", props: {
+  timestamp: DateTime.now,
+  show_current_year: true
+}) %>
+
+<br>
+
+<%= pb_rails("timestamp", props: {
+  timestamp: DateTime.now,
+  show_time: false,
+  show_current_year: true
+}) %>

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_show_current_year.jsx

@@ -0,0 +1,25 @@
+import React from 'react'
+import Timestamp from '../_timestamp'
+
+
+const TimestampShowCurrentYear = (props) => {
+  return (
+    <div>
+      <Timestamp
+          showCurrentYear
+          timestamp={new Date()}
+          {...props}
+      />
+      <br />
+      <Timestamp
+          showCurrentYear
+          showTime={false}
+          timestamp={new Date()}
+          {...props}
+      />
+
+    </div>
+  )
+}
+
+export default TimestampShowCurrentYear

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_show_current_year.md

@@ -0,0 +1 @@
+Use the `showCurrentYear`/`show_current_year` prop to show the year even if it is the current year. This is set to false by default.

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_show_date.html.erb

@@ -0,0 +1,4 @@
+<%= pb_rails("timestamp", props: {
+  timestamp: DateTime.now,
+  show_date: false,
+}) %>

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_show_date.jsx

@@ -0,0 +1,17 @@
+import React from 'react'
+import Timestamp from '../_timestamp'
+
+const TimestampShowDate = (props) => {
+  return (
+    <div>
+      <Timestamp
+          align="left"
+          showDate={false}
+          timestamp={new Date()}
+          {...props}
+      />
+    </div>
+  )
+}
+
+export default TimestampShowDate

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_show_date.md

@@ -0,0 +1 @@
+The `showDate`/`show_date` prop is set to true by default but can be set to false to hide the date.

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_show_time.html.erb

@@ -0,0 +1,18 @@
+<%= pb_rails("timestamp", props: {
+  timestamp: DateTime.now,
+  show_time: false,
+}) %>
+
+<br>
+
+<%= pb_rails("timestamp", props: {
+  timestamp: DateTime.now + 4.years,
+  show_time: false,
+}) %>
+
+<br>
+
+<%= pb_rails("timestamp", props: {
+  timestamp: DateTime.now - 1.year,
+  show_time: false
+}) %>

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_show_time.jsx

@@ -0,0 +1,44 @@
+import React from 'react'
+import Timestamp from '../_timestamp'
+
+const todaysDate = new Date()
+const futureYear = new Date().getFullYear() + 4
+const pastYear = new Date().getFullYear() - 1
+const month = new Date().getMonth()
+const date = new Date().getDate()
+const hours = new Date().getHours()
+const minutes = new Date().getMinutes()
+const futureDate = new Date(futureYear, month, date, hours, minutes)
+const pastDate = new Date(pastYear, month, date, hours, minutes)
+
+const TimestampShowTime = (props) => {
+  return (
+    <div>
+      <Timestamp
+          align="left"
+          showTime={false}
+          timestamp={todaysDate}
+          {...props}
+      />
+      <br />
+
+      <Timestamp
+          align="left"
+          showTime={false}
+          timestamp={futureDate}
+          {...props}
+      />
+
+      <br />
+
+      <Timestamp
+          align="left"
+          showTime={false}
+          timestamp={pastDate}
+          {...props}
+      />
+    </div>
+  )
+}
+
+export default TimestampShowTime

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_show_time.md

@@ -0,0 +1 @@
+The `showTime`/`show_time` prop is set to true by default but can be set to false to hide the time.

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_timezones.html.erb

@@ -3,37 +3,30 @@
   show_date: false,
   show_timezone: true,
   timezone: "America/New_York",
-  align: "left"
 }) %>
 
 <br>
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now,
-  show_date: true,
   show_timezone: true,
   timezone: "America/New_York",
-  align: "left"
 }) %>
 
 <br>
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now + 4.years,
-  show_date: true,
   show_timezone: true,
   timezone: "America/New_York",
-  align: "left"
 }) %>
 
 <br>
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now - 1.year,
-  show_date: true,
   show_timezone: true,
   timezone: "America/New_York",
-  align: "left"
 }) %>
 
 <br>
@@ -43,37 +36,30 @@
   show_date: false,
   show_timezone: true,
   timezone: "Asia/Hong_Kong",
-  align: "left"
 }) %>
 
 <br>
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now,
-  show_date: true,
   show_timezone: true,
   timezone: "Asia/Hong_Kong",
-  align: "left"
 }) %>
 
 <br>
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now + 4.years,
-  show_date: true,
   show_timezone: true,
   timezone: "Asia/Hong_Kong",
-  align: "left"
 }) %>
 
 <br>
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now - 1.year,
-  show_date: true,
   show_timezone: true,
   timezone: "Asia/Hong_Kong",
-  align: "left"
 }) %>
 
 <br>

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_timezones.jsx

@@ -15,7 +15,6 @@ const TimestampTimezones = (props) => {
   return (
     <div>
       <Timestamp
-          align="left"
           showDate={false}
           showTimezone
           timestamp={todaysDate}
@@ -26,8 +25,6 @@ const TimestampTimezones = (props) => {
       <br />
 
       <Timestamp
-          align="left"
-          showDate
           showTimezone
           timestamp={todaysDate}
           timezone="America/New_York"
@@ -37,8 +34,6 @@ const TimestampTimezones = (props) => {
       <br />
 
       <Timestamp
-          align="left"
-          showDate
           showTimezone
           timestamp={futureDate}
           timezone="America/New_York"
@@ -48,8 +43,6 @@ const TimestampTimezones = (props) => {
       <br />
 
       <Timestamp
-          align="left"
-          showDate
           showTimezone
           timestamp={pastDate}
           timezone="America/New_York"
@@ -59,7 +52,6 @@ const TimestampTimezones = (props) => {
       <br />
 
       <Timestamp
-          align="left"
           showDate={false}
           showTimezone
           timestamp={todaysDate}
@@ -70,8 +62,6 @@ const TimestampTimezones = (props) => {
       <br />
 
       <Timestamp
-          align="left"
-          showDate
           showTimezone
           timestamp={todaysDate}
           timezone="Asia/Hong_Kong"
@@ -81,8 +71,6 @@ const TimestampTimezones = (props) => {
       <br />
 
       <Timestamp
-          align="left"
-          showDate
           showTimezone
           timestamp={futureDate}
           timezone="Asia/Hong_Kong"
@@ -92,8 +80,6 @@ const TimestampTimezones = (props) => {
       <br />
 
       <Timestamp
-          align="left"
-          showDate
           showTimezone
           timestamp={pastDate}
           timezone="Asia/Hong_Kong"

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_timezones.md

@@ -0,0 +1 @@
+The `showTimezone`/`show_timezone` prop can be used to show the timezone as well. This is set to false by default. **NOTE**: This prop must be used in conjunction with the `timezone` prop to specify which timezone to display. 

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_unstyled.html.erb

@@ -2,8 +2,6 @@
 
 <%= pb_rails("timestamp", props: {
   timestamp: DateTime.now,
-  show_date: true,
-  align: "left",
   unstyled: true,
 }) %>
 
@@ -14,8 +12,6 @@
 <%= pb_rails("title", props: { size: 1 }) do %>
   <%= pb_rails("timestamp", props: {
     timestamp: DateTime.now,
-    show_date: true,
-    align: "left",
     unstyled: true,
   }) %>
 <% end %>

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_unstyled.jsx

@@ -10,8 +10,6 @@ const TimestampUnstyled = (props) => {
           text="Basic unstyled example"
       />
       <Timestamp
-          align="left"
-          showDate
           timestamp={new Date()}
           unstyled
           {...props}
@@ -24,8 +22,6 @@ const TimestampUnstyled = (props) => {
       />
       <Title size={1}>
         <Timestamp
-            align="left"
-            showDate
             timestamp={new Date()}
             unstyled
             {...props}

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_updated.jsx

@@ -17,7 +17,6 @@ const TimestampUpdated = (props) => {
       <br />
 
       <Timestamp
-          showUser={false}
           timestamp={todaysDate}
           variant="updated"
           {...props}

data/app/pb_kits/playbook/pb_timestamp/docs/_timestamp_updated.md

@@ -0,0 +1,5 @@
+Use variant `updated` to show last updated at timestamp. 
+
+This variant can be customized using the optional `showUser`/`show_user` prop to show user as part of the text. When showing the user, pass in the user name using the `text` prop as shown. 
+
+`showUser`/`show_user` is set to false by default.