playbook_ui_docs 15.1.0.pre.rc.4 → 15.1.0.pre.rc.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c2198c826706c282db886f35423210d995385972fb11a9d65f922458584110c
-  data.tar.gz: 53339fd384faf368040832dc960167d2114f2e6de21e887db76207e9849c62f9
+  metadata.gz: 7f9fb27a99a038c00f85e0aa3ed845923a6b47afb3639b279b0a571a4124a2df
+  data.tar.gz: 4660aeab2b31c55f177793d979d24182b50829987ea848870fac0c6fbc768a2c
 SHA512:
-  metadata.gz: e2721bc496b4b2d9e6b789b7c0e3e59d9e2a60b5f7ed87588c91dce4402f6e03d982ab63f7d9ce6d9c6f803d49b251efe0a93f8312c179b19b9748cb3db92185
-  data.tar.gz: bb89e112116d6314c2003636b5fcf6061515cb90bb2218b2e704a7d3bbe7c2a659c26207f21b9da2b10a62a3a8ec414499c5f738f39b29be6ce0ef50e7a0ad2e
+  metadata.gz: 3d4eeccae472b32deff92aa9a402a7a13c612bd67fb65e8c00b8f9c214cb96e34c8c1dc7c42dd67424e258ae9a23d6d021b85d95cce1858e73de5ae18559e53b
+  data.tar.gz: 03e629b883356a9dc9e660b844f93bd9e525cfde39b766cc365abc2a13837e480aa1ba3c84c8eec72f9d83279242ba59a39fd89c935f187adadcb63d98617768

data/app/pb_kits/playbook/pb_contact/docs/_contact_default.html.erb

@@ -13,7 +13,7 @@
 }) %>
 
 <%= pb_rails("contact", props: {
-  contact_type: "wrong number",
+  contact_type: "work",
   contact_value: "3245627482",
 }) %>
 
@@ -21,3 +21,18 @@
   contact_type: "work-cell",
   contact_value: "349-185-9988",
 }) %>
+
+<%= pb_rails("contact", props: {
+  contact_type: "wrong-phone",
+  contact_value: "2124396666",
+}) %>
+
+<%= pb_rails("contact", props: {
+  contact_type: "extension",
+  contact_value: "1233",
+}) %>
+
+<%= pb_rails("contact", props: {
+  contact_type: "international",
+  contact_value: "+44 7700 900461",
+}) %>

data/app/pb_kits/playbook/pb_contact/docs/_contact_default.jsx

@@ -28,6 +28,21 @@ const ContactDefault = (props) => {
           contactValue="3245627482"
           {...props}
       />
+      <Contact
+          contactType="wrong-phone"
+          contactValue="2124396666"
+          {...props}
+      />
+      <Contact
+          contactType='extension'
+          contactValue="1234"
+          {...props}
+      />
+      <Contact
+          contactType="international"
+          contactValue="+44 7700 900461"
+          {...props}
+      />
     </div>
   )
 }

data/app/pb_kits/playbook/pb_contact/docs/_contact_default.md

@@ -0,0 +1,5 @@
+The Contact kit automatically formats US phone numbers when the `contactType` / `contact_type` is one of: `home` (default), `work`, `cell`, `work-cell`, `wrong-phone`.
+
+- Use `email` to display emails.
+- Use `international` to display International phone numbers exactly as provided (no formatting applied).
+- Use `extension` to display four digit phone extensions.

data/app/pb_kits/playbook/pb_contact/docs/_contact_with_detail.html.erb

@@ -26,3 +26,9 @@
   contact_value: "1233",
   contact_detail: "Ext",
 }) %>
+
+<%= pb_rails("contact", props: {
+  contact_type: "international",
+  contact_value: "+44 7700 900461",
+  contact_detail: "International",
+}) %>

data/app/pb_kits/playbook/pb_contact/docs/_contact_with_detail.jsx

@@ -33,6 +33,12 @@ const ContactDefault = (props) => {
           contactValue="1234"
           {...props}
       />
+      <Contact
+          contactDetail="International"
+          contactType="international"
+          contactValue="+44 7700 900461"
+          {...props}
+      />
     </div>
   )
 }

data/app/pb_kits/playbook/pb_passphrase/docs/_passphrase_breached.html.erb

@@ -4,8 +4,8 @@
 
 <%= pb_rails("caption", props: { size: 'xs', text: "hello", id: "caption_breached" }) %>
 
-<%= javascript_tag do %>
-    window.addEventListener("DOMContentLoaded", () => {
+<script>
+    window.addEventListener("load", () => {
 
     // variables for the kits you are targeting 
     const passphrase = document.querySelector(".passphrase_breached").querySelector("input")
@@ -142,4 +142,4 @@
     });
 
   })
-<% end %>
+</script>

data/app/pb_kits/playbook/pb_passphrase/docs/_passphrase_common.html.erb

@@ -10,8 +10,8 @@
 <%= pb_rails("caption", props: { size: 'xs', text: "hello", id: "caption_common" }) %>
 
 
-<%= javascript_tag do %>
-    window.addEventListener("DOMContentLoaded", () => {
+<script>
+    window.addEventListener("load", () => {
 
     const commonText = document.querySelector("#body_common")
 
@@ -133,4 +133,4 @@
     });
 
   })
-<% end %>
+</script>

data/app/pb_kits/playbook/pb_passphrase/docs/_passphrase_confirmation.html.erb

@@ -4,8 +4,8 @@
 
 <div id="match"> </div>
 
-<%= javascript_tag do %>
-    window.addEventListener("DOMContentLoaded", () => {   
+<script>
+    window.addEventListener("load", () => {   
 
       const useState = (defaultValue) => {
           let value = defaultValue;
@@ -48,4 +48,4 @@
 
       }
     })
-<% end %>
+</script>

data/app/pb_kits/playbook/pb_passphrase/docs/_passphrase_meter_settings.html.erb

@@ -32,8 +32,8 @@
 
 
 
-<%= javascript_tag do %>
-    window.addEventListener("DOMContentLoaded", () => {
+<script>
+    window.addEventListener("load", () => {
 
 
     // variables for the passphrase kits you are targeting 
@@ -320,4 +320,4 @@
 
   
   })
-<% end %>
+</script>

data/app/pb_kits/playbook/pb_passphrase/docs/_passphrase_strength_change.html.erb

@@ -7,8 +7,8 @@
 <%= pb_rails("text_input", props: { label: "Passphrase Strength", value: "0", disabled: true, id: "calc_strength_change" }) %>
 
 
-<%= javascript_tag do %>
-    window.addEventListener("DOMContentLoaded", () => {
+<script>
+    window.addEventListener("load", () => {
 
     // variables for the kits you are targeting 
     const passphrase = document.querySelector(".passphrase_change").querySelector("input")
@@ -120,4 +120,4 @@
     });
 
   })
-<% end %>
+</script>

data/app/pb_kits/playbook/pb_rich_text_editor/docs/_rich_text_editor_preview.html.erb

@@ -13,8 +13,8 @@
 <script>
   document.addEventListener('DOMContentLoaded', () => {
     function handleButtonClick() {
-      const editorContainer = [...document.querySelectorAll('[data-react-props]')]
-        .find(element => element.getAttribute('data-react-props')?.includes('"id":"content-preview-editor"'))
+      const editorContainer = [...document.querySelectorAll('[data-pb-react-props]')]
+        .find(element => element.getAttribute('data-pb-react-props')?.includes('"id":"content-preview-editor"'))
 
       const editorElement = editorContainer?.querySelector('trix-editor')
       const inputId = editorElement?.getAttribute('input')

data/app/pb_kits/playbook/pb_section_separator/docs/_section_separator_children.html.erb

@@ -11,4 +11,27 @@
             padding_right: "xs" 
         }) %>
     <% end %>
+<% end %>
+
+<%= pb_rails("flex", props: { classname: "flex-container", margin_top: "lg", vertical: "stretch" }) do %>
+    <%= pb_rails("body", props: { classname: "flex-item" }) do %>
+        Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
+    <% end %>
+    <%= pb_rails("section_separator", props: { orientation: "vertical" }) do %>
+        <%= pb_rails("card", props: {
+            border_radius: "rounded",
+            justify_content: "center",
+            padding: "none"
+        })  do %>
+            <%= pb_rails("caption", props: {
+                text: "TODAY",
+                size: "xs",
+                padding_left: "xs",
+                padding_right: "xs" 
+            }) %>
+        <% end %>
+    <% end %>
+    <%= pb_rails("body", props: { classname: "flex-item" }) do %>
+        Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua
+    <% end %>
 <% end %>

data/app/pb_kits/playbook/pb_section_separator/docs/_section_separator_children.jsx

@@ -2,8 +2,25 @@ import React from 'react'
 import Card from '../../pb_card/_card'
 import Caption from '../../pb_caption/_caption'
 import SectionSeparator from '../../pb_section_separator/_section_separator'
+import Flex from '../../pb_flex/_flex'
+import FlexItem from '../../pb_flex/_flex_item'
 
-const children = (
+const childrenHorizontal = (
+    <Card
+        borderRadius="rounded"
+        justifyContent="center"
+        padding="none"
+    >
+        <Caption
+            paddingLeft="xs"
+            paddingRight="xs"
+            size="xs"
+            text="TODAY"
+        />
+    </Card>
+)
+
+const childrenVertical = (
     <Card
         borderRadius="rounded"
         justifyContent="center"
@@ -20,12 +37,33 @@ const children = (
 
 const SectionSeparatorChildren = (props) => {
     return (
-        <SectionSeparator
-            {...props}
-            lineStyle='dashed'
-        >
-            {children}
-        </SectionSeparator>
+        <>
+            <SectionSeparator
+                {...props}
+                lineStyle='dashed'
+            >
+                {childrenHorizontal}
+            </SectionSeparator>
+            <Flex
+                inline="flex-container"
+                marginTop="lg"
+                vertical="stretch"
+            >
+                <FlexItem>
+                    {'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua'}
+                </FlexItem>
+                    <SectionSeparator
+                        orientation="vertical"
+                        {...props}
+                    >
+                        {childrenVertical}
+                    </SectionSeparator>
+                <FlexItem>
+                    {'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua'}
+                </FlexItem>
+            </Flex>
+        </>
+        
     )
 }
 

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
+}) %>