playbook_ui_docs 13.13.0.pre.alpha.play900startratingasinput1657 → 13.13.0.pre.alpha.play10221678

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ea9616a1a0ebfeb207646e73702e51eaad93c2a6051126363db8d1cbaa2a674
-  data.tar.gz: 125091d72d224c90a9aff3905a753e975addb7514c9a2ea34f6ba9488bcb07bd
+  metadata.gz: 8ed5f092b2d08dbaa2e7a36c3fcfd931e2f5cfe26d35fd553789bb029c620e63
+  data.tar.gz: 947c21a797f7c633cf6b1982acdc408f782e68d761ae1ec8fa0938ff07883b14
 SHA512:
-  metadata.gz: db21daeb18c456a242a57e1534923d99261be6b2d0a5a03192f46d29fb4a2702f25befdd28ebb98f47b70aba3b222d79b43a66f80a7b454092b0e17aeda2f841
-  data.tar.gz: a6702ed707537ccae106f2c5c46a7a9d60eaa1219fb1e82e843a98b238b4ac1e82928367dbf20c312dccd0db4e9f3204d3d72f7d834694df703c8a3d02d9230c
+  metadata.gz: 44d1f4c358ffb7f2b5ff5f44a913d1a669a1afdfaea4114a3abac63d4a8b61b0a25ca357242cbde6183f93e53658c71da36558927cc026611350885c8de339d6
+  data.tar.gz: 96a590487494497046d5dbd904863d109a6a770ec6a38de8d443495162040e340cf097ef3a7b8153b6b1a40ef618346b236db0b92f202759a362c92e9d4c342a

data/app/pb_kits/playbook/pb_date_picker/docs/_date_picker_quick_pick_custom.html.erb

@@ -0,0 +1,29 @@
+<%= pb_rails("date_picker", props: {
+  allow_input: true,
+  custom_quick_pick_dates: {
+    dates: [
+      # Allow Playbook to handle the logic...
+      {
+        label: "Last 15 months",
+        value: {
+          timePeriod: "months",
+          amount: 15,
+        },
+      },
+      # Or, be explicit with an exact date range for more control...
+      {
+        label: "First Week of June 2022",
+        value: ["06/01/2022", "06/07/2022"],
+      },
+    ],
+  },
+  end_date_id: "quick-pick-end-date",
+  end_date_name: "quick-pick-end-date",
+  mode: "range",
+  picker_id: "date-picker-quick-pick-custom",
+  placeholder: "mm/dd/yyyy to mm/dd/yyyy",
+  selection_type: "quickpick",
+  start_date_id: "quick-pick-start-date",
+  start_date_name: "quick-pick-start-date"
+}) %>
+

data/app/pb_kits/playbook/pb_date_picker/docs/_date_picker_quick_pick_custom.jsx

@@ -0,0 +1,34 @@
+import React from "react"
+import DatePicker from "../_date_picker"
+
+const DatePickerQuickPickCustom = (props) => (
+  <>
+   <DatePicker
+       allowInput
+       customQuickPickDates={{
+        dates: [
+          // Allow Playbook to handle the logic...
+          {
+            label: "Last 15 months",
+            value: {
+              timePeriod: "months",
+              amount: 15,
+            },
+          },
+          // Or, be explicit with an exact date range for more control...
+          {
+            label: "First Week of June 2022",
+            value: ["06/01/2022", "06/07/2022"],
+          },
+        ],
+      }}
+       mode='range'
+       pickerId='date-picker-quick-pick-custom-override'
+       placeholder='mm/dd/yyyy to mm/dd/yyyy'
+       selectionType='quickpick'
+       {...props}
+   />
+  </>
+)
+
+export default DatePickerQuickPickCustom

data/app/pb_kits/playbook/pb_date_picker/docs/_date_picker_quick_pick_custom.md

@@ -0,0 +1,7 @@
+The customQuickPickDates/custom_quick_pick_dates prop allows for the user/dev to define their own quick pick dates. 
+The prop accepts an object with two key/value pairs: dates & override (separate doc example below).
+
+The dates property accepts an array of objects. Each object in the array has label and value properties. The label is what will be displayed in the UI of the dropdown menu. The value property is just the date that is going to be passed to the datepicker. The value property can be an array of two strings that represent a range, allowing for the dev to be extremely specific. Additionally, the dates array allows for a clean, simple API under that automatically converts dates in a common vernacular. 
+
+The timePeriod property accepts "days", "weeks", "months", "quarters" or "years", representing past time periods. 
+The amount property accepts any number.

data/app/pb_kits/playbook/pb_date_picker/docs/_date_picker_quick_pick_custom_override.html.erb

@@ -0,0 +1,28 @@
+<%= pb_rails("date_picker", props: {
+  allow_input: true,
+  custom_quick_pick_dates: {
+    override: false,
+    dates: [
+      {
+        label: "Last 15 months",
+        value: {
+          timePeriod: "months",
+          amount: 15,
+        },
+      },
+      {
+        label: "First Week of June 2022",
+        value: ["06/01/2022", "06/07/2022"],
+      },
+    ],
+  },
+  end_date_id: "quick-pick-end-date",
+  end_date_name: "quick-pick-end-date",
+  mode: "range",
+  picker_id: "date-picker-quick-pick-override",
+  placeholder: "mm/dd/yyyy to mm/dd/yyyy",
+  selection_type: "quickpick",
+  start_date_id: "quick-pick-start-date",
+  start_date_name: "quick-pick-start-date"
+}) %>
+

data/app/pb_kits/playbook/pb_date_picker/docs/_date_picker_quick_pick_custom_override.jsx

@@ -0,0 +1,34 @@
+import React from "react"
+import DatePicker from "../_date_picker"
+
+const DatePickerQuickPickCustomOverride = (props) => (
+  <>
+    <DatePicker
+        allowInput
+        customQuickPickDates={{
+        override: false,
+        dates: [
+          {
+            label: "Last 15 months",
+            value: {
+              timePeriod: "months",
+              amount: 15,
+            },
+          },
+          {
+            label: "First Week of June 2022",
+            value: ["06/01/2022", "06/07/2022"],
+          },
+        ],
+      }}
+        marginTop='lg'
+        mode='range'
+        pickerId='date-picker-quick-pick-custom'
+        placeholder='mm/dd/yyyy to mm/dd/yyyy'
+        selectionType='quickpick'
+        {...props}
+    />
+  </>
+)
+
+export default DatePickerQuickPickCustomOverride

data/app/pb_kits/playbook/pb_date_picker/docs/_date_picker_quick_pick_custom_override.md

@@ -0,0 +1 @@
+The customQuickPickDates/custom_quick_pick_dates prop allows for an override boolean. The override allows for the user to completely override the quick pick dates that ship with the component. Default of `override` is set to true. If you would like to simply append your dates to the default quick pick dates, set this prop to false explicitly.

data/app/pb_kits/playbook/pb_date_picker/docs/_date_picker_quick_pick_react.jsx

@@ -1,5 +1,5 @@
-import React from 'react'
-import DatePicker from '../_date_picker'
+import React from "react"
+import DatePicker from "../_date_picker"
 
 const DatePickerQuickPickReact = (props) => (
   <>

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

@@ -10,6 +10,8 @@ examples:
   - date_picker_range: Range
   - date_picker_quick_pick_rails: Range (Quick Pick)
   - date_picker_quick_pick_range_limit: Range (Quick Pick w/ “This” Range limit)
+  - date_picker_quick_pick_custom: Custom Quick Pick Dates
+  - date_picker_quick_pick_custom_override: Custom Quick Pick Dates (append to defaults)
   - date_picker_format: Format
   - date_picker_disabled: Disabled Dates
   - date_picker_min_max: Min Max
@@ -37,6 +39,8 @@ examples:
   - date_picker_range: Range
   - date_picker_quick_pick_react: Range (Quick Pick)
   - date_picker_quick_pick_range_limit: Range (Quick Pick w/ “This” Range limit)
+  - date_picker_quick_pick_custom: Custom Quick Pick Dates
+  - date_picker_quick_pick_custom_override: Custom Quick Pick Dates (append to defaults)
   - date_picker_format: Format
   - date_picker_disabled: Disabled Dates
   - date_picker_min_max: Min Max

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

@@ -22,3 +22,5 @@ export { default as DatePickerAllowInput } from './_date_picker_allow_input'
 export { default as DatePickerQuickPickReact } from './_date_picker_quick_pick_react'
 export { default as DatePickerQuickPickRangeLimit } from './_date_picker_quick_pick_range_limit'
 export { default as DatePickerOnClose } from './_date_picker_on_close.jsx'
+export { default as DatePickerQuickPickCustom } from './_date_picker_quick_pick_custom'
+export { default as DatePickerQuickPickCustomOverride } from './_date_picker_quick_pick_custom_override'

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_default.html.erb

@@ -1,11 +1,13 @@
-<%= pb_rails("star_rating", props: { padding_bottom: "xs" }) %>
+<%= pb_rails("star_rating") %>
 
-<%= pb_rails("star_rating", props: { rating: 1, padding_bottom: "xs" }) %>
+<br>
 
-<%= pb_rails("star_rating", props: { rating: 2, padding_bottom: "xs" }) %>
+<%= pb_rails("star_rating", props: { rating: 3 }) %>
 
-<%= pb_rails("star_rating", props: { rating: 3, padding_bottom: "xs" }) %>
+<br>
 
-<%= pb_rails("star_rating", props: { rating: 4, padding_bottom: "xs" }) %>
+<%= pb_rails("star_rating", props: { rating: 1.5 }) %>
 
-<%= pb_rails("star_rating", props: { rating: 5, padding_bottom: "xs" }) %>
+<br>
+
+<%= pb_rails("star_rating", props: { rating: 5 }) %>

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_default.jsx

@@ -4,38 +4,25 @@ import StarRating from '../_star_rating'
 
 const StarRatingDefault = (props) => (
   <>
-    <StarRating
-        paddingBottom="xs"
-        {...props}
-    />
+    <StarRating />
 
+    <br />
 
     <StarRating
-        paddingBottom="xs"
-        rating={0.9}
+        rating={3}
         {...props}
     />
 
-    <StarRating
-        paddingBottom="xs"
-        rating={1.5}
-        {...props}
-    />
+    <br />
 
     <StarRating
-        paddingBottom="xs"
-        rating={3}
+        rating={1.5}
         {...props}
     />
 
-    <StarRating
-        paddingBottom="xs"
-        rating={4.2}
-        {...props}
-    />
+    <br />
 
     <StarRating
-        paddingBottom="xs"
         rating={5}
         {...props}
     />

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_hide.html.erb

@@ -1,3 +1 @@
-<%= pb_rails("star_rating", props: { rating: 3, padding_bottom: "xs" }) %>
-<%= pb_rails("star_rating", props: { rating: 3, layout_option: "number", padding_bottom: "xs" }) %>
-<%= pb_rails("star_rating", props: { rating: 3, layout_option: "onestar", padding_bottom: "xs" }) %>
+<%= pb_rails("star_rating", props: { rating: 3.5, hide_rating: true }) %>

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_hide.jsx

@@ -3,30 +3,13 @@ import React from 'react'
 import StarRating from '../_star_rating'
 
 const StarRatingHide = (props) => (
-  <>
 
-    <StarRating
-        paddingBottom="xs"
-        rating={3}
-        {...props}
-    />
+  <StarRating
+      hideRating
+      rating={3.5}
+      {...props}
+  />
 
-
-    <StarRating
-        layoutOption={"number"}
-        paddingBottom="xs"
-        rating={3}
-        {...props}
-    />
-
-    <StarRating
-        layoutOption={"onestar"}
-        paddingBottom="xs"
-        rating={3}
-        {...props}
-    />
-
-  </>
 )
 
 export default StarRatingHide

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

@@ -1,16 +1,9 @@
 examples:
+
   rails:
-    - star_rating_default: Default
-    - star_rating_color_options: Color Options
-    - star_rating_background_options: Background Options
-    - star_rating_hide: Layout Options
-    - star_rating_number_config: Number Config
-    - star_rating_size_options: Size Options
+  - star_rating_default: Default
+  - star_rating_hide: Hide Rating Value
 
   react:
-    - star_rating_default: Default
-    - star_rating_color_options: Color Options
-    - star_rating_background_options: Background Options
-    - star_rating_hide: Layout Options
-    - star_rating_number_config: Number Config
-    - star_rating_size_options: Size Options
+  - star_rating_default: Default
+  - star_rating_hide: Hide Rating Value

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

@@ -1,11 +1,3 @@
 export { default as StarRatingDefault } from './_star_rating_default.jsx'
 
-export { default as StarRatingColorOptions } from './_star_rating_color_options.jsx'
-
-export { default as StarRatingBackgroundOptions } from './_star_rating_background_options.jsx'
-
 export { default as StarRatingHide } from './_star_rating_hide.jsx'
-
-export { default as StarRatingNumberConfig } from './_star_rating_number_config.jsx'
-
-export { default as StarRatingSizeOptions } from './_star_rating_size_options.jsx'