playbook_ui 13.13.0.pre.alpha.PLAY1090csstokens1675 → 13.13.0.pre.alpha.play10221678

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4f5112d15fbd1aea3bd5aeed163b6daa26b0862336eceb9ec28a88aae96ae08
-  data.tar.gz: fdb0fa976c88bc864f92f0be7b5fb40989b66fb9207e763ebc3870397fe50c69
+  metadata.gz: 930c0e3d2587afad1b9ea3d50a4a80e37c9c2772ef0a9b12eb6499831bbbcbb5
+  data.tar.gz: 9d8fe14193b9826133a1b47709975b5165aa54b44437feae9aa5eaa244879cfe
 SHA512:
-  metadata.gz: 5c8898ab19ba131fb88110e5fc2b238496ed3c7c7a3d62a5da7c39d8db69d78ffe9aa8e70034c7f8ec9b94ae87a79293abdbe159fa358536d61724d307b34e1f
-  data.tar.gz: ba5c98b0229c3f43470c57016c3fee4313bf2320f9c39351a7c302b178425fb87a6db3b7874f59abeb3a8c067edfd35205d8ef95aa0014b0a50e23da3f7ab38e
+  metadata.gz: cd5afb9fe7f8b9b3fcf226049a50ce83df67baddceb0bd22ccbbea5d8db2ec661390be9f7b5e9229da84fcddd4dba909167728b849a9d91215343577b8f9a16e
+  data.tar.gz: 271d69aee52700ec882a56a7f48fe02b6cac9b2d83a3ea3e0c465b75a6dfc501356c0ee080a3f6fb2a178f1697ee05e38c6737c393a0ea73f414037902a9addf

data/app/pb_kits/playbook/index.js

@@ -130,16 +130,4 @@ export { default as dialogHelper } from './pb_dialog/dialogHelper'
 
 //Theming
 export {default as mapTheme} from './pb_map/pbMapTheme'
-export {default as useCollapsible} from './pb_collapsible/useCollapsible'
-
-// CSS Tokens
-export { default as borderRadius } from './tokens/exports/_border_radius.scss'
-export { default as colors } from './tokens/exports/_colors.scss'
-export { default as lineHeight } from './tokens/exports/_line_height.scss'
-export { default as opacity } from './tokens/exports/_opacity.scss'
-export { default as positioning } from './tokens/exports/_positioning.scss'
-export { default as scale } from './tokens/exports/_scale.scss'
-export { default as screenSizes } from './tokens/exports/_screen_sizes.scss'
-export { default as shadows } from './tokens/exports/_shadows.scss'
-export { default as spacing } from './tokens/exports/_spacing.scss'
-export { default as typography } from './tokens/exports/_typography.scss'
+export {default as useCollapsible} from './pb_collapsible/useCollapsible'

data/app/pb_kits/playbook/pb_date_picker/_date_picker.tsx

@@ -13,6 +13,7 @@ type DatePickerProps = {
   allowInput?: boolean,
   aria?: { [key: string]: string },
   className?: string,
+  customQuickPickDates: { override: boolean, dates: any[] },
   dark?: boolean,
   data?: { [key: string]: string },
   defaultDate?: string,
@@ -56,6 +57,7 @@ const DatePicker = (props: DatePickerProps): React.ReactElement => {
     allowInput = false,
     aria = {},
     className,
+    customQuickPickDates,
     dark = false,
     data = {},
     defaultDate = '',
@@ -104,6 +106,7 @@ const DatePicker = (props: DatePickerProps): React.ReactElement => {
 useEffect(() => {
   datePickerHelper({
     allowInput,
+    customQuickPickDates,
     defaultDate,
     disableDate,
     disableRange,

data/app/pb_kits/playbook/pb_date_picker/date_picker.rb

@@ -5,6 +5,8 @@ module Playbook
     class DatePicker < Playbook::KitBase
       prop :allow_input, type: Playbook::Props::Boolean,
                          default: false
+      prop :custom_quick_pick_dates, type: Playbook::Props::HashProp,
+                                     default: {}
       prop :dark, type: Playbook::Props::Boolean,
                   default: false
       prop :default_date, type: Playbook::Props::String,
@@ -79,6 +81,7 @@ module Playbook
       def date_picker_config
         {
           allowInput: allow_input,
+          customQuickPickDates: custom_quick_pick_dates,
           defaultDate: default_date,
           disableDate: disable_date,
           disableRange: disable_range,

data/app/pb_kits/playbook/pb_date_picker/date_picker_helper.ts

@@ -11,6 +11,7 @@ const getPositionElement = (element: string | Element) => {
 
 type DatePickerConfig = {
   closeOnSelect?: boolean,
+  customQuickPickDates: { override: boolean, dates: any[] },
   disableDate?: number[],
   disableRange?: number[],
   disableWeekdays?: number[],
@@ -34,6 +35,7 @@ const datePickerHelper = (config: DatePickerConfig, scrollContainer: string | HT
   const {
     allowInput,
     closeOnSelect = true,
+    customQuickPickDates = { override: true, dates: [] },
     defaultDate,
     disableDate,
     disableRange,
@@ -121,27 +123,26 @@ const datePickerHelper = (config: DatePickerConfig, scrollContainer: string | HT
     }
   }
 
-  const setPlugins = (thisRangesEndToday: boolean) => {
+  const setPlugins = (thisRangesEndToday: boolean, customQuickPickDates: any) => {
     const pluginList = []
-
+  
     // month and week selection
     if (selectionType === "month" || plugins.length > 0) {
       pluginList.push(monthSelectPlugin({ shorthand: true, dateFormat: 'F Y', altFormat: 'F Y' }))
     } else if ( selectionType === "week") {
       pluginList.push(weekSelect())
-
+  
     } else if (selectionType === "quickpick") {
-    //------- QUICKPICK VARIANT PLUGIN -------------//
-    pluginList.push(quickPickPlugin(thisRangesEndToday))
+      //------- QUICKPICK VARIANT PLUGIN -------------//
+      pluginList.push(quickPickPlugin(thisRangesEndToday, customQuickPickDates))
     }
-
+  
     // time selection
     if (enableTime) pluginList.push(timeSelectPlugin({ caption: timeCaption, showTimezone: showTimezone}))
-
-
+  
     return pluginList
   }
-
+  
   const getDateFormat = () => {
     return enableTime ? `${format} ${timeFormat}` : format
   }
@@ -181,7 +182,7 @@ const datePickerHelper = (config: DatePickerConfig, scrollContainer: string | HT
     onYearChange: [() => {
       yearChangeHook()
     }],
-    plugins: setPlugins(thisRangesEndToday),
+    plugins: setPlugins(thisRangesEndToday, customQuickPickDates),
     position,
     positionElement: getPositionElement(positionElement),
     prevArrow: '<i class="far fa-angle-left"></i>',

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_date_picker/plugins/quickPick.tsx

@@ -19,9 +19,14 @@ type pluginDataType = {
   rangesButtons: [] | any,
 }
 
+type customQuickPickDatesType = {
+  override: boolean,
+  dates: { label: string, value: string[] | { timePeriod: string, amount: number } }[],
+}
+
 let activeLabel = ""
 
-const quickPickPlugin = (thisRangesEndToday: boolean) => {
+const quickPickPlugin = (thisRangesEndToday: boolean, customQuickPickDates: customQuickPickDatesType | undefined) => {
   return function (fp: FpTypes & any): any {
     const today = new Date()
     const yesterday = DateTime.getYesterdayDate(new Date())
@@ -46,8 +51,38 @@ const quickPickPlugin = (thisRangesEndToday: boolean) => {
     const lastYearStartDate = DateTime.getPreviousYearStartDate(new Date())
     const lastYearEndDate = DateTime.getPreviousYearEndDate(new Date())
 
-    // variable that holds the ranges available
-    const ranges = {
+    const calculateDateRange = (timePeriod: string, amount: number): Date[] => {
+      const endDate = new Date();
+      let startDate = new Date();
+    
+      switch (timePeriod) {
+        case 'days':
+          startDate.setDate(endDate.getDate() - amount);
+          break;
+        case 'weeks':
+          startDate.setDate(endDate.getDate() - (amount * 7));
+          break;
+        case 'months':
+          startDate.setMonth(endDate.getMonth() - amount);
+          break;
+        case 'quarters':
+          startDate.setMonth(endDate.getMonth() - (amount * 3));
+          break;
+        case 'years':
+          startDate.setFullYear(endDate.getFullYear() - amount);
+          break;
+        default:
+          throw new Error('Invalid time period');
+      }
+      return [startDate, endDate];
+    };
+  
+
+    type rangesType = {
+      [key: string]: Date[]
+    };
+
+    let ranges: rangesType = {
       'Today': [today, today],
       'Yesterday': [yesterday, yesterday],
       'This week': [thisWeekStartDate, thisWeekEndDate],
@@ -58,16 +93,47 @@ const quickPickPlugin = (thisRangesEndToday: boolean) => {
       'Last month': [lastMonthStartDate, lastMonthEndDate],
       'Last quarter': [lastQuarterStartDate, lastQuarterEndDate],
       'Last year': [lastYearStartDate, lastYearEndDate]
+    };
+
+    
+    if (customQuickPickDates && Object.keys(customQuickPickDates).length !== 0) {
+      if (customQuickPickDates.dates.length && customQuickPickDates.override === false) {
+        customQuickPickDates.dates.forEach((item) => {
+          if (Array.isArray(item.value)) {
+            ranges[item.label] = item.value.map((dateStr: string) => new Date(dateStr));
+          } else {
+            ranges[item.label] = calculateDateRange(
+              item.value.timePeriod,
+              item.value.amount
+            )
+          }
+        })
+      } else if(customQuickPickDates.dates.length && customQuickPickDates.override !== false) {
+        ranges = {}
+        customQuickPickDates.dates.forEach((item) => {
+          if (Array.isArray(item.value)) {
+            ranges[item.label] = item.value.map((dateStr: string) => new Date(dateStr));
+          } else {
+            ranges[item.label] = calculateDateRange(
+              item.value.timePeriod,
+              item.value.amount
+            )
+          }
+        })
+      }
     }
 
+
     // creating the ul element for the nav dropdown and giving it classnames
     const rangesNav = document.createElement('ul');
 
+
     // creating the pluginData object that will hold the properties of this plugin
     const pluginData: pluginDataType = {
       ranges: ranges,
       rangesNav: rangesNav,
       rangesButtons: [],
+
     };
 
     /**