playbook_ui_docs 15.5.0.pre.rc.2 → 15.5.0.pre.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04b955046309ad4547cdb6f8ef77c114ee297a9dc57d336500202c2b3d7d1540
-  data.tar.gz: 177351a33c7a3a234e7ac0ce8ac6c382219a193565240df02911743f650c567a
+  metadata.gz: 67521f39b3bf3e61512adc17e8bac9e1038f17adebe8ead35fac4f256e4c1a5d
+  data.tar.gz: 499f18183db76bd3e1dee73d53c1918829a82082ac829448127ced136bf8f367
 SHA512:
-  metadata.gz: d767a5acd9f1c4a3f7ee4f85143c68b64ac724c8d50ea007b89cbf2769f1c05f801c9b57f8200dc1cbe81cd371b138dc467801e54ad362770723afc0a6042378
-  data.tar.gz: d405ad62a51d89948c3775e10a43fa5401f969298ace09e4b8a655f1679e377e8856ba038cd1666878d2829628133388e98d5182b904b799fe83a703c7ed1fb1
+  metadata.gz: ab6215c0a3811cc649c1b961a5a97bbe9a65831611fa59295edaf9f12017350d469d979642fcc0e6e46b719aeafdf66da83cf33b0217fbd67988c0f16d617bed
+  data.tar.gz: 87c3cff9e2433d5d76b8c34229619b02dc28e78c3285b98022ef4cc82634af5431134d00dd4e49984fd0eb425e2a8f1c7790ef8a42a3979ec180dc2b16b23e0a

data/app/pb_kits/playbook/pb_copy_button/docs/_copy_button_icon_variant.jsx

@@ -0,0 +1,24 @@
+import React from 'react'
+
+import CopyButton from '../../pb_copy_button/_copy_button'
+import Textarea from '../../pb_textarea/_textarea'
+
+const CopyIconVariant = (props) => (
+  <div>
+    <CopyButton
+        {...props}
+        text="Copy Text"
+        tooltipPlacement="right"
+        tooltipText="Text copied!"
+        value="Playbook makes it easy to support bleeding edge, or legacy systems. Use Playbook’s 200+ components and end-to-end design language to create simple, intuitive and beautiful experiences with ease."
+        variant="icon"
+    />
+
+    <Textarea
+        {...props}
+        placeholder="Copy and paste here"
+    />
+  </div>
+)
+
+export default CopyIconVariant

data/app/pb_kits/playbook/pb_copy_button/docs/_copy_button_icon_variant_react.md

@@ -0,0 +1 @@
+Pass in `variant="icon"` to replace the Button with the Circle Icon Button kit.

data/app/pb_kits/playbook/pb_copy_button/docs/example.yml

@@ -8,3 +8,4 @@ examples:
   - copy_button_default: Default
   - copy_button_from: Copy From
   - copy_button_hook: Copy Hook
+  - copy_button_icon_variant: Icon Variant

data/app/pb_kits/playbook/pb_copy_button/docs/index.js

@@ -1,3 +1,4 @@
 export { default as CopyButtonDefault } from './_copy_button_default.jsx'
 export { default as CopyButtonFrom } from './_copy_button_from.jsx' 
 export { default as CopyButtonHook } from './_copy_button_hook.jsx'
+export { default as CopyButtonIconVariant } from './_copy_button_icon_variant.jsx'

data/app/pb_kits/playbook/pb_progress_step/docs/_description.md

@@ -1,5 +1 @@
-Progress step kit is used to show the progress of a process. There are three types of steps in this kit: completed, active, and inactive. Completed steps are indicated by a solid, blue circle (with or without an icon). The current, or active, step is indicated by an outlined blue circle. The inactive, or future, step is indicated by a solid gray circle. 
-
-**Tracker**
-You must set the icon prop to true for this kit.
-This variant takes children just like the default progress step. It is best to use the caption kit for children in this variant.
+Progress Step kit is used to show the progress of a process. There are three types of steps in this kit: completed, active, and inactive. Completed steps are indicated by a solid, blue circle (with or without an icon). The current, or active, step is indicated by an outlined blue circle. The inactive, or future, step is indicated by a solid gray circle. 

data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_color.html.erb

@@ -0,0 +1,14 @@
+<br><br>
+<%= pb_rails("progress_step",props:{ variant:"tracker", icon:true, color: "info"}) do %>
+  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
+      <%= pb_rails("caption", props:{text: "Ordered"})%>
+  <% end %>
+  <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
+      <%= pb_rails("caption", props:{text: "Shipped"})%>
+  <% end %>
+  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
+      <%= pb_rails("caption", props:{text: "Delivered"})%>
+  <% end %>
+<% end %>
+
+<br>

data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_color.jsx

@@ -0,0 +1,29 @@
+import React from 'react'
+
+import ProgressStep from '../_progress_step.tsx'
+import ProgressStepItem from '../_progress_step_item.tsx'
+import Caption from '../../pb_caption/_caption'
+
+const ProgressStepColor = (props) => (
+  <div>
+    <br />
+    <ProgressStep 
+        color="info"
+        icon 
+        variant="tracker" 
+        {...props}
+    >
+      <ProgressStepItem status="complete">
+        <Caption>{'Ordered'}</Caption>
+      </ProgressStepItem>
+      <ProgressStepItem status="active">
+        <Caption>{'Shipped'}</Caption>
+      </ProgressStepItem>
+      <ProgressStepItem status="inactive">
+        <Caption>{'Delivered'}</Caption>
+      </ProgressStepItem>
+    </ProgressStep>
+  </div>
+)
+
+export default ProgressStepColor

data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_color.md

@@ -0,0 +1,3 @@
+The `color` prop can also be used to set color for the tracker variant. Options for color are `primary` and `info` with default being set to `primary`.
+
+**NOTE**: The `color` prop is only available with the `tracker` variant.

data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_custom_icon.jsx

@@ -0,0 +1,31 @@
+import React from 'react'
+
+import ProgressStep from '../_progress_step.tsx'
+import ProgressStepItem from '../_progress_step_item.tsx'
+import Caption from '../../pb_caption/_caption'
+
+const ProgressStepCustomIcon = (props) => (
+  <div>
+    <br />
+    <ProgressStep 
+        icon 
+        variant="tracker" 
+        {...props}
+    >
+      <ProgressStepItem status="complete">
+        <Caption>{'Ordered'}</Caption>
+      </ProgressStepItem>
+      <ProgressStepItem 
+          icon="exclamation-triangle"
+          status="active" 
+      >
+        <Caption>{'Shipped'}</Caption>
+      </ProgressStepItem>
+      <ProgressStepItem status="inactive">
+        <Caption>{'Delivered'}</Caption>
+      </ProgressStepItem>
+    </ProgressStep>
+  </div>
+)
+
+export default ProgressStepCustomIcon

data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_custom_icon.md

@@ -0,0 +1 @@
+Custom icons can also be set for individual steps. Simply use the `icon` prop for the relevant `ProgressStepItem`/`progress_step_item` as shown here. 

data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_default.html.erb

@@ -39,7 +39,10 @@
   <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
   step 2
   <% end %>
-  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
+  <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
   step 3
+  <% end %>
+    <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
+  step 4
   <% end %>
 <% end %>

data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_default.jsx

@@ -6,7 +6,6 @@ import ProgressStepItem from '../_progress_step_item.tsx'
 const ProgressStepDefault = (props) => (
   <div>
     <ProgressStep
-        icon
         {...props}
     >
       <ProgressStepItem status="complete" />
@@ -19,12 +18,24 @@ const ProgressStepDefault = (props) => (
 
     <ProgressStep {...props}>
       <ProgressStepItem status="complete">{'Step 1'}</ProgressStepItem>
-      <ProgressStepItem status="active">{'Step 2'}</ProgressStepItem>
-      <ProgressStepItem status="inactive">{'Step 3'}</ProgressStepItem>
+      <ProgressStepItem status="complete">{'Step 2'}</ProgressStepItem>
+      <ProgressStepItem status="active">{'Step 3'}</ProgressStepItem>
+      <ProgressStepItem status="inactive">{'Step 4'}</ProgressStepItem>
+      <ProgressStepItem status="inactive">{'Step 5'}</ProgressStepItem>
     </ProgressStep>
 
     <br />
     <br />
+
+    <ProgressStep 
+        icon
+        {...props}
+    >
+      <ProgressStepItem status="complete">{'Step 1'}</ProgressStepItem>
+      <ProgressStepItem status="complete">{'Step 2'}</ProgressStepItem>
+      <ProgressStepItem status="active">{'Step 3'}</ProgressStepItem>
+      <ProgressStepItem status="inactive">{'Step 4'}</ProgressStepItem>
+    </ProgressStep>
   </div>
 )
 

data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_default.md

@@ -0,0 +1,3 @@
+The default Progress Step kit sets orientation to horizontal and can be used with completed, active, and inactive steps as shown here.
+
+`icon` is a boolean prop that can also be set to true to render icons within the steps indicator. `icon` is false by default.

data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_tracker.md

@@ -0,0 +1,3 @@
+The `variant` prop can be set to `tracker` to achieve this UI. Tracker is only available with the horizontal orientation and it is also recommended that you set the `icon` prop to true for this variant. 
+
+This variant takes children just like the default progress step, however, it is best to use the caption kit for children in this variant.

data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_vertical.html.erb

@@ -25,13 +25,7 @@
     Child
   <% end %>
   <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
-    <%= pb_rails("card", props: {highlight: {position: "side", color:"windows"}}) do %>
-  Card content
-<% end %>
-<br>
-<%= pb_rails("card", props: {highlight: {position: "side", color:"windows"}}) do %>
-  Card content
-<% end %>
+    Child
   <% end %>
   <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
     Child

data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_vertical.md

@@ -0,0 +1 @@
+`orientation` can also be set to `vertical` as shown here. By default, this is set to `horizontal`.

data/app/pb_kits/playbook/pb_progress_step/docs/example.yml

@@ -3,6 +3,7 @@ examples:
   - progress_step_default: Default
   - progress_step_vertical: Vertical
   - progress_step_tracker: Tracker
+  - progress_step_color: Color
   - progress_step_custom_icon: Custom Icon
   - progress_step_tooltip: Tooltip
 
@@ -10,4 +11,6 @@ examples:
   - progress_step_default: Default
   - progress_step_vertical: Vertical
   - progress_step_tracker: Tracker
+  - progress_step_color: Color
+  - progress_step_custom_icon: Custom Icon
   - progress_step_tracker_click_events: Using State

data/app/pb_kits/playbook/pb_progress_step/docs/index.js

@@ -2,3 +2,5 @@ export { default as ProgressStepDefault } from './_progress_step_default.jsx'
 export { default as ProgressStepVertical } from './_progress_step_vertical.jsx'
 export { default as ProgressStepTracker } from './_progress_step_tracker.jsx'
 export { default as ProgressStepTrackerClickEvents } from './_progress_step_tracker_click_events.jsx'
+export { default as ProgressStepColor } from './_progress_step_color.jsx'
+export { default as ProgressStepCustomIcon } from './_progress_step_custom_icon.jsx'