playbook_ui 14.17.0.pre.rc.0 → 14.17.0

data/app/pb_kits/playbook/pb_nav/_nav_item.test.js

@@ -95,11 +95,13 @@ test('should not have a left border', () => {
 test('should have a right icon', () => {
     render(<NavDefault iconRight="angle-down" />)
     const kit = screen.getByTestId(itemTestId)
-    expect(kit).toContainHTML('<i class="pb_icon_kit far pb_nav_list_item_icon_right fa-fw fa-angle-down" />')
+    const icon = kit.querySelector(".pb_custom_icon.pb_nav_list_item_icon_right")
+    expect(icon).toBeInTheDocument()
 })
 
 test('should have a left icon', () => {
-    render(<NavDefault iconLeft="users-class" />)
+    render(<NavDefault iconLeft="angle-up" />)
     const kit = screen.getByTestId(itemTestId)
-    expect(kit).toContainHTML('<i class="pb_icon_kit far pb_nav_list_item_icon_left fa-fw fa-users-class" />')
+    const icon = kit.querySelector(".pb_custom_icon.pb_nav_list_item_icon_left")
+    expect(icon).toBeInTheDocument()
 })

data/app/pb_kits/playbook/pb_section_separator/docs/_section_separator_vertical.md

@@ -0,0 +1 @@
+To guarantee the vertical section separator displays properly, please add the `vertical: "stretch"`/`vertical="stretch"` property to the parent container (which is commonly a Flex container). This will stretch the container’s child elements vertically and ensure the section separator appears as expected.

data/app/pb_kits/playbook/pb_stat_change/stat_change.test.js

@@ -19,23 +19,27 @@ test('it renders preset icon', () => {
     render(
       <StatChange
           change="increase"
+          id="preset-icon"
           value="28.4"
       />
     )
 
-    const kit = screen.getByLabelText('arrow-up icon')
-    expect(kit).toBeTruthy
+    const kit = document.querySelector('#preset-icon')
+    const icon = kit.querySelector(".pb_custom_icon")
+    expect(icon).toBeInTheDocument()
 })
 
 test('it renders custom icon', () => {
     render(
       <StatChange
           icon="chart-line-down"
+          id="custom-icon"
           value={6.1}
       />
 
     )
 
-    const kit = screen.getByLabelText('chart-line-down icon')
-    expect(kit).toBeTruthy
+    const kit = document.querySelector('#custom-icon')
+    const icon = kit.querySelector(".pb_custom_icon")
+    expect(icon).toBeInTheDocument()
 })

data/app/pb_kits/playbook/pb_table/styles/_striped.scss

@@ -1,7 +1,7 @@
-[class^=pb_table] {
+[class^=pb_table]:not(:has(colgroup)) {
   &.striped {
     tbody, .pb_table_tbody {
-      tr:nth-child(odd), .pb_table_tr:nth-child(odd) {
+      tr:nth-child(odd):not(.pb_background_kit), .pb_table_tr:nth-child(odd):not(.pb_background_kit) {
         background-color: $bg_light;
       }
     }
@@ -10,7 +10,7 @@
   &.dark {
     &.striped {
       tbody, .pb_table_tbody {
-        tr:nth-child(odd), .pb_table_tr:nth-child(odd) {
+        tr:nth-child(odd):not(.pb_background_kit), .pb_table_tr:nth-child(odd):not(.pb_background_kit) {
           background-color: $bg_dark;
         }
       }

data/app/pb_kits/playbook/pb_tooltip/index.js

@@ -1,22 +1,26 @@
 import PbEnhancedElement from '../pb_enhanced_element'
-import {
-  createPopperLite as createPopper,
-  flip,
-  offset,
-  preventOverflow,
-} from '@popperjs/core'
-
-const TOOLTIP_OFFSET = [0, 20]
+import { computePosition, offset, flip, shift, arrow, autoUpdate } from '@floating-ui/dom'
+
+const TOOLTIP_OFFSET = 20
 const TOOLTIP_TIMEOUT = 250
+const SAFE_ZONE_MARGIN = 1
 
 export default class PbTooltip extends PbEnhancedElement {
   static get selector() {
-    return '[data-pb-tooltip-kit="true"][data-pb-tooltip-interaction="false"]:not([data-pb-tooltip-delay-open]):not([data-pb-tooltip-delay-close])'
+    return '[data-pb-tooltip-kit]'
   }
 
   connect() {
+    if (this.tooltipInteraction) {
+      document.addEventListener('mousemove', (e) => {
+        this.lastMouseX = e.clientX
+        this.lastMouseY = e.clientY
+      })
+    }
+    
     this.triggerElements.forEach((trigger) => {
       const method = this.triggerMethod
+      const interactionEnabled = this.tooltipInteraction
 
       if (method === 'click') {
         trigger.addEventListener('click', () => {
@@ -24,29 +28,66 @@ export default class PbTooltip extends PbEnhancedElement {
         })
       } else {
         trigger.addEventListener('mouseenter', () => {
+          clearSafeZoneListener(this)
+          clearTimeout(this.mouseleaveTimeout)
+          this.currentTrigger = trigger
+          const delayOpen = this.delayOpen ? parseInt(this.delayOpen) : TOOLTIP_TIMEOUT
           this.mouseenterTimeout = setTimeout(() => {
             this.showTooltip(trigger)
-            this.checkCloseTooltip(trigger)
-          }, TOOLTIP_TIMEOUT)
-
-          trigger.addEventListener('mouseleave', () => {
-            clearTimeout(this.mouseenterTimeout)
-            setTimeout(() => {
-              this.hideTooltip()
-            }, 0)
-          }, { once: true })
+            if (interactionEnabled) {
+              this.checkCloseTooltip(trigger)
+            }
+          }, delayOpen)
         })
 
-        this.tooltip.addEventListener('mouseenter', () => {
+        trigger.addEventListener('mouseleave', () => {
           clearTimeout(this.mouseenterTimeout)
+          if (this.delayClose) {
+            const delayClose = parseInt(this.delayClose)
+            this.mouseleaveTimeout = setTimeout(() => {
+              if (interactionEnabled) {
+                this.attachSafeZoneListener()
+              } else {
+                this.hideTooltip()
+              }
+            }, delayClose)
+          } else {
+            if (interactionEnabled) {
+              this.attachSafeZoneListener()
+            } else {
+              this.hideTooltip()
+            }
+          }
         })
-        this.tooltip.addEventListener('mouseleave', () => {
-          this.hideTooltip()
-        })
+
+        if (interactionEnabled) {
+          this.tooltip.addEventListener('mouseenter', () => {
+            clearSafeZoneListener(this)
+          })
+
+          this.tooltip.addEventListener('mouseleave', () => {
+            this.attachSafeZoneListener()
+          })
+        }
       }
     })
   }
 
+  attachSafeZoneListener() {
+    clearSafeZoneListener(this)
+    this.safeZoneHandler = (e) => {
+      if (!this.currentTrigger) return
+      const triggerRect = this.currentTrigger.getBoundingClientRect()
+      const tooltipRect = this.tooltip.getBoundingClientRect()
+      const safeRect = getSafeZone(triggerRect, tooltipRect, this.position, SAFE_ZONE_MARGIN)
+      if (!isPointInsideRect(e.clientX, e.clientY, safeRect)) {
+        this.hideTooltip()
+        clearSafeZoneListener(this)
+      }
+    }
+    document.addEventListener('mousemove', this.safeZoneHandler)
+  }
+
   checkCloseTooltip(trigger) {
     document.querySelector('body').addEventListener('click', ({ target }) => {
       const isTooltip = target.closest(`#${this.tooltipId}`) === this.tooltip
@@ -62,27 +103,46 @@ export default class PbTooltip extends PbEnhancedElement {
   showTooltip(trigger) {
     if (this.shouldShowTooltip === 'false') return
 
-    this.popper = createPopper(trigger, this.tooltip, {
-      placement: this.position,
-      strategy: 'fixed',
-      modifiers: [
-        {
-          name: 'offset',
-          options: {
-            offset: TOOLTIP_OFFSET,
-          },
-        },
-        {
-          name: 'arrow',
-          options: {
-            element: document.querySelector(`#${this.tooltipId}-arrow`),
-          },
-        },
-        offset,
-        preventOverflow,
-        flip,
-      ],
+    clearSafeZoneListener(this)
+
+    this.tooltip.style.opacity = '1'
+    this.tooltip.style.visibility = 'visible'
+    this.tooltip.style.pointerEvents = 'auto'
+
+    if (this.cleanup) {
+      this.cleanup()
+    }
+
+    const arrowElement = document.querySelector(`#${this.tooltipId}-arrow`)
+
+    this.cleanup = autoUpdate(trigger, this.tooltip, () => {
+      computePosition(trigger, this.tooltip, {
+        placement: this.position,
+        strategy: 'fixed',
+        middleware: [
+          offset({ mainAxis: TOOLTIP_OFFSET, crossAxis: 0 }),
+          flip(),
+          shift(),
+          arrow({ element: arrowElement })
+        ],
+      }).then(({ x, y, placement, middlewareData }) => {
+        Object.assign(this.tooltip.style, {
+          left: `${x}px`,
+          top: `${y}px`,
+          position: 'fixed'
+        })
+        this.tooltip.setAttribute('data-popper-placement', placement)
+        if (arrowElement && middlewareData.arrow) {
+          const { x: arrowX, y: arrowY } = middlewareData.arrow
+          Object.assign(arrowElement.style, {
+            left: arrowX != null ? `${arrowX}px` : '',
+            top: arrowY != null ? `${arrowY}px` : '',
+            position: 'absolute'
+          })
+        }
+      })
     })
+
     this.tooltip.classList.add('show')
 
     if (this.triggerMethod === 'click') {
@@ -94,39 +154,50 @@ export default class PbTooltip extends PbEnhancedElement {
   }
 
   hideTooltip() {
+    if (!this.tooltip) return
+
     this.tooltip.classList.add('fade_out')
     setTimeout(() => {
-      if (!this.popper) return
-      this.popper.destroy()
+      if (this.cleanup) {
+        this.cleanup()
+        this.cleanup = null
+      }
       this.tooltip.classList.remove('show')
       this.tooltip.classList.remove('fade_out')
+      this.tooltip.style.opacity = '0'
+      this.tooltip.style.visibility = 'hidden'
+      this.tooltip.style.pointerEvents = 'none'
+      this.tooltip.style.position = ''
+      this.tooltip.style.top = ''
+      this.tooltip.style.left = ''
+      this.tooltip.style.transform = ''
     }, TOOLTIP_TIMEOUT)
   }
 
   get triggerElements() {
     let triggerEl
-
     if (this.triggerElementId) {
       triggerEl = document.querySelector(`#${this.triggerElementId}`)
-    } else {
+    } else if (this.triggerElementSelector) {
       const selectorIsId = this.triggerElementSelector.indexOf('#') > -1
       triggerEl = selectorIsId
-        ? document.querySelector(`${this.triggerElementSelector}`)
-        : document.querySelectorAll(`${this.triggerElementSelector}`)
+        ? document.querySelector(this.triggerElementSelector)
+        : document.querySelectorAll(this.triggerElementSelector)
+    } else {
+      triggerEl = this.element
     }
-
     if (!triggerEl) {
-      console.error('Tooltip Kit: an invalid or unavailable DOM reference was provided!')
+      console.error('Tooltip Kit: No valid trigger element found!')
       return []
     }
-
-    if (!triggerEl.length) triggerEl = [triggerEl]
-    return (this._triggerElements = this._triggerElements || triggerEl)
+    if (triggerEl.length === undefined) {
+      triggerEl = [triggerEl]
+    }
+    return triggerEl
   }
 
   get tooltip() {
-    return (this._tooltip =
-      this._tooltip || this.element.querySelector(`#${this.tooltipId}`))
+    return (this._tooltip = this._tooltip || this.element.querySelector(`#${this.tooltipId}`))
   }
 
   get position() {
@@ -152,4 +223,60 @@ export default class PbTooltip extends PbEnhancedElement {
   get triggerMethod() {
     return this.element.dataset.pbTooltipTriggerMethod || 'hover'
   }
-}
+
+  get tooltipInteraction() {
+    return this.element.dataset.pbTooltipInteraction === 'true'
+  }
+  
+  get delayOpen() {
+    return this.element.dataset.pbTooltipDelayOpen
+  }
+  
+  get delayClose() {
+    return this.element.dataset.pbTooltipDelayClose
+  }
+}
+
+function clearSafeZoneListener(context) {
+  if (context.safeZoneHandler) {
+    document.removeEventListener('mousemove', context.safeZoneHandler)
+    context.safeZoneHandler = null
+  }
+}
+
+function getSafeZone(triggerRect, tooltipRect, placement, margin) {
+  let safeRect = {}
+  if (placement.startsWith('top')) {
+    safeRect.left = triggerRect.left - margin
+    safeRect.right = triggerRect.right + margin
+    safeRect.top = tooltipRect.bottom - margin
+    safeRect.bottom = triggerRect.top + margin
+  } else if (placement.startsWith('bottom')) {
+    safeRect.left = triggerRect.left - margin
+    safeRect.right = triggerRect.right + margin
+    safeRect.top = triggerRect.bottom - margin
+    safeRect.bottom = tooltipRect.top + margin
+  } else if (placement.startsWith('left')) {
+    safeRect.top = triggerRect.top - margin
+    safeRect.bottom = triggerRect.bottom + margin
+    safeRect.left = tooltipRect.right - margin
+    safeRect.right = triggerRect.left + margin
+  } else if (placement.startsWith('right')) {
+    safeRect.top = triggerRect.top - margin
+    safeRect.bottom = triggerRect.bottom + margin
+    safeRect.left = triggerRect.right - margin
+    safeRect.right = tooltipRect.left + margin
+  } else {
+    safeRect = {
+      left: triggerRect.left - margin,
+      right: triggerRect.right + margin,
+      top: triggerRect.top - margin,
+      bottom: triggerRect.bottom + margin,
+    }
+  }
+  return safeRect
+}
+
+function isPointInsideRect(x, y, rect) {
+  return x >= rect.left && x <= rect.right && y >= rect.top && y <= rect.bottom
+}

data/app/pb_kits/playbook/pb_tooltip/tooltip.html.erb

@@ -1,11 +1,8 @@
-<%= content_tag(:div,
-      id: object.id,
-      data: object.data,
-      class: object.classname,
+<%= pb_content_tag(:div,
       style: remove_height_properties(combined_html_options[:style]) || "",
       **combined_html_options.except(:style)) do %>
   <div class="tooltip_tooltip" id="<%= object.tooltip_id %>" role="tooltip" style="<%= object.height_and_width_helper %>">
     <%= content.presence %>
     <div class="arrow" id="<%= object.tooltip_id %>-arrow"></div>
   </div>
-<% end %>
+<% end %>

data/app/pb_kits/playbook/pb_typeahead/docs/_typeahead_with_highlight.jsx

@@ -18,18 +18,18 @@ const USERS = [
     territory: "PHL",
   },
   {
-    name: "Jason Cypret",
-    title: "Vice President of User Experience",
+    name: "Carlos Lima",
+    title: "Nitro Developer",
     territory: "PHL",
   },
   {
     name: "Stephen Marshall",
-    title: "Senior User Experience Engineer",
+    title: "Senior Nitro Developer",
     territory: "PHL",
   },
   {
     name: "Jasper Furniss",
-    title: "Senior User Experience Engineer",
+    title: "Lead User Experience Engineer",
     territory: "PHL",
   },
 ];

data/app/pb_kits/playbook/pb_typeahead/index.ts

@@ -1,5 +1,5 @@
 import PbEnhancedElement from '../pb_enhanced_element'
-import { debounce } from 'lodash'
+import { debounce } from '../utilities/object'
 
 export default class PbTypeahead extends PbEnhancedElement {
   _searchInput: HTMLInputElement
@@ -284,4 +284,4 @@ export default class PbTypeahead extends PbEnhancedElement {
     if (visible) visibilityProperty = '1'
     this.resultsLoadingIndicator.style.opacity = visibilityProperty
   }
-}
+}

data/app/pb_kits/playbook/pb_typeahead/typeahead.html.erb

@@ -1,11 +1,8 @@
 <% if object.is_react? %>
   <%= react_component('Typeahead', object.typeahead_react_options) %>
 <% else %>
-  <%= content_tag(:div,
-                id: object.id,
-                data: object.data,
-                class: object.classname + object.inline_class,
-                **combined_html_options) do %>
+  <%= pb_content_tag(:div,
+                     class: object.classname + object.inline_class) do %>
     <div class="pb_typeahead_wrapper">
       <div class="pb_typeahead_loading_indicator" data-pb-typeahead-kit-loading-indicator>
         <%= pb_rails("icon", props: {

data/app/pb_kits/playbook/pb_user/user.html.erb

@@ -1,9 +1,4 @@
-<%= content_tag(:div,
-    aria: object.aria,
-    class: object.classname,
-    data: object.data,
-    id: object.id,
-    **combined_html_options) do %>
+<%= pb_content_tag do %>
   <% if object.avatar_url.present? || object.avatar %>
     <%= pb_rails("avatar", props: {
       name: object.name,

data/app/pb_kits/playbook/pb_user_badge/user_badge.html.erb

@@ -1,8 +1,3 @@
-<%= content_tag(:div,
-    aria: object.aria,
-    class: object.classname,
-    data: object.data,
-    id: object.id,
-    **combined_html_options) do %>
+<%= pb_content_tag do %>
   <%= content_tag(:div, object.display_badge, class: "pb_user_badge_wrapper") %>
 <% end %>

data/app/pb_kits/playbook/utilities/globalProps.ts

@@ -1,4 +1,4 @@
-import { omit } from 'lodash'
+import { omit } from './object'
 import { camelToSnakeCase } from './text'
 
 import {

data/app/pb_kits/playbook/utilities/object.test.js

@@ -1,4 +1,4 @@
-import { isEmpty, get, isString, uniqueId, omitBy, noop, merge, filter, find, partial } from './object';
+import { isEmpty, get, isString, uniqueId, omitBy, noop, merge, filter, find, partial, map, cloneDeep, omit, debounce } from './object';
 
 describe('Lodash functions', () => {
   describe('isEmpty', () => {
@@ -234,4 +234,152 @@ describe('Lodash functions', () => {
       expect(joinPartial('b', 'c')).toBe('a_b_c');
     });
   });
+
+  describe('map', () => {
+    test('maps over an array with a function iteratee', () => {
+      const arr = [1, 2, 3];
+      const result = map(arr, (num) => num * 2);
+      expect(result).toEqual([2, 4, 6]);
+    });
+
+    test('maps over an array with a string iteratee', () => {
+      const arr = [{ value: 1 }, { value: 2 }, { value: 3 }];
+      const result = map(arr, 'value');
+      expect(result).toEqual([1, 2, 3]);
+    });
+
+    test('maps over an object with a function iteratee', () => {
+      const obj = { a: 1, b: 2, c: 3 };
+      const result = map(obj, (val, key) => key + val);
+      expect(result.sort()).toEqual(['a1', 'b2', 'c3'].sort());
+    });
+
+    test('maps over an object with a string iteratee', () => {
+      const obj = {
+        one: { num: 1 },
+        two: { num: 2 },
+        three: { num: 3 },
+      };
+      const result = map(obj, 'num');
+      expect(result.sort()).toEqual([1, 2, 3].sort());
+    });
+
+    test('returns original values if no iteratee provided', () => {
+      const arr = [1, 2, 3];
+      const result = map(arr);
+      expect(result).toEqual([1, 2, 3]);
+    });
+  });
+
+  describe('cloneDeep', () => {
+    test('clones primitive values', () => {
+      expect(cloneDeep(42)).toBe(42);
+      expect(cloneDeep('test')).toBe('test');
+      expect(cloneDeep(null)).toBe(null);
+    });
+
+    test('clones arrays deeply', () => {
+      const arr = [1, [2, 3]];
+      const cloned = cloneDeep(arr);
+      expect(cloned).toEqual(arr);
+      cloned[1][0] = 99;
+      expect(arr[1][0]).toBe(2);
+    });
+
+    test('clones objects deeply', () => {
+      const obj = { a: { b: 2 } };
+      const cloned = cloneDeep(obj);
+      expect(cloned).toEqual(obj);
+      cloned.a.b = 99;
+      expect(obj.a.b).toBe(2);
+    });
+
+    test('clones Date objects', () => {
+      const date = new Date();
+      const cloned = cloneDeep(date);
+      expect(cloned).not.toBe(date);
+      expect(cloned.getTime()).toBe(date.getTime());
+    });
+
+    test('clones RegExp objects', () => {
+      const regex = /test/gi;
+      const cloned = cloneDeep(regex);
+      expect(cloned).not.toBe(regex);
+      expect(cloned.source).toBe(regex.source);
+      expect(cloned.flags).toBe(regex.flags);
+    });
+  });
+
+  describe('omit', () => {
+    test('omits specified keys from object', () => {
+      const obj = { a: 1, b: 2, c: 3 };
+      expect(omit(obj, 'a', 'c')).toEqual({ b: 2 });
+    });
+
+    test('supports array of keys to omit', () => {
+      const obj = { a: 1, b: 2, c: 3 };
+      expect(omit(obj, ['b'])).toEqual({ a: 1, c: 3 });
+    });
+
+    test('returns empty object for null or non-object input', () => {
+      expect(omit(null, 'a')).toEqual({});
+      expect(omit("string", 'a')).toEqual({});
+    });
+
+    test('returns original object if no keys match', () => {
+      const obj = { a: 1, b: 2 };
+      expect(omit(obj, 'c')).toEqual({ a: 1, b: 2 });
+    });
+  });
+
+  describe('debounce', () => {
+    beforeEach(() => {
+      jest.useFakeTimers();
+    });
+
+    afterEach(() => {
+      jest.useRealTimers();
+    });
+
+    test('delays execution until wait time has passed', () => {
+      const func = jest.fn();
+      const debounced = debounce(func, 1000);
+      debounced();
+      expect(func).not.toHaveBeenCalled();
+      jest.advanceTimersByTime(500);
+      expect(func).not.toHaveBeenCalled();
+      jest.advanceTimersByTime(500);
+      expect(func).toHaveBeenCalledTimes(1);
+    });
+
+    test('calls function only once when called repeatedly', () => {
+      const func = jest.fn();
+      const debounced = debounce(func, 1000);
+      debounced();
+      debounced();
+      debounced();
+      jest.advanceTimersByTime(1000);
+      expect(func).toHaveBeenCalledTimes(1);
+    });
+
+    test('immediate option calls function on first call', () => {
+      const func = jest.fn();
+      const debounced = debounce(func, 1000, true);
+      debounced();
+      expect(func).toHaveBeenCalledTimes(1);
+      debounced();
+      debounced();
+      jest.advanceTimersByTime(1000);
+      expect(func).toHaveBeenCalledTimes(1);
+    });
+
+    test('subsequent call after wait period works with immediate option', () => {
+      const func = jest.fn();
+      const debounced = debounce(func, 1000, true);
+      debounced();
+      jest.advanceTimersByTime(1100);
+      debounced();
+      expect(func).toHaveBeenCalledTimes(2);
+    });
+  });
 });