playbook_ui 14.6.0.pre.rc.15 → 14.6.0.pre.rc.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a85d84ea47e1b511c8e5fcc45bddd310d6001373522ae76e35bcde28f7be2bf4
-  data.tar.gz: 97bc4539729392e6a2df0a70fc67a30356ff62a936dcfa52f6f9b1c5761ed9b6
+  metadata.gz: 3af661732daba63430f0f483623a635c5d436f107770da5b5170484f225a7ff1
+  data.tar.gz: 7d4210b2fba6e2c9456761f9b8529d30e9136e469616c74e3751021d76bd9a3c
 SHA512:
-  metadata.gz: 75d02da02b56ccc26a746da13527b0ec26893bcc16a03658f800e520ccfc1c8b2231745929733539eb473ec9a9200527f5164eb586f864e6c919805fd1b1d290
-  data.tar.gz: 7530e8b2cec153a53c1ae7174daad5201da4ce903b83ac13b4073f0511acad8c20c0fefaf50511b696ce140ee629dad9d0e939736b9b7c8957a0631a70ddb3e6
+  metadata.gz: c910e8a3dc3abaf477202519102e544edd0448cb60940f305c08c0e2b1606c8aa791b38269107595f82b3ddbb4ac7317f49ffb851e04565f47a9b4635105b16a
+  data.tar.gz: 85ceeb8d7f3e76dd7d2a151067be85e77250997274f8289faa3e266c5875d5e4843f95738b05c022a2a5dcda3151ba7f33c0e8ba89d7acb5a337713b2d280114

data/app/pb_kits/playbook/pb_dropdown/_dropdown.tsx

@@ -1,4 +1,4 @@
-import React, { useState, useRef, useEffect } from "react";
+import React, { useState, useRef, useEffect, forwardRef, useImperativeHandle } from "react";
 import classnames from "classnames";
 import { buildAriaProps, buildCss, buildDataProps, buildHtmlProps } from "../utilities/props";
 import { globalProps } from "../utilities/globalProps";
@@ -38,7 +38,14 @@ type DropdownProps = {
     triggerRef?: any;
 };
 
-const Dropdown = (props: DropdownProps) => {
+interface DropdownComponent
+    extends React.ForwardRefExoticComponent<DropdownProps & React.RefAttributes<unknown>> {
+    Option: typeof DropdownOption;
+    Trigger: typeof DropdownTrigger;
+    Container: typeof DropdownContainer;
+}
+
+const Dropdown = forwardRef((props: DropdownProps, ref: any) => {
     const {
         aria = {},
         autocomplete = false,
@@ -125,7 +132,7 @@ const Dropdown = (props: DropdownProps) => {
     const filteredOptions = optionsWithBlankSelection?.filter((option: GenericObject) => {
         const label = typeof option.label === 'string' ? option.label.toLowerCase() : option.label;
         return String(label).toLowerCase().includes(filterItem.toLowerCase());
-    });    
+    });
 
     // For keyboard accessibility: Set focus within dropdown to selected item if it exists
     useEffect(() => {
@@ -175,6 +182,14 @@ const Dropdown = (props: DropdownProps) => {
         dark
     });
 
+    useImperativeHandle(ref, () => ({
+        clearSelected: () => {
+            setSelected({});
+            setFilterItem("");
+            setIsDropDownClosed(true);
+            onSelect && onSelect(null);
+        },
+    }));
 
     return (
         <div {...ariaProps}
@@ -258,8 +273,9 @@ const Dropdown = (props: DropdownProps) => {
             </DropdownContext.Provider>
         </div>
     )
-};
+}) as DropdownComponent
 
+Dropdown.displayName = "Dropdown";
 Dropdown.Option = DropdownOption;
 Dropdown.Trigger = DropdownTrigger;
 Dropdown.Container = DropdownContainer;

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_clear_selection.jsx

@@ -0,0 +1,45 @@
+import React, { useRef } from 'react'
+import { Button, Dropdown } from 'playbook-ui'
+
+const options = [
+    {
+        label: "United States",
+        value: "United States",
+    },
+    {
+        label: "Canada",
+        value: "Canada",
+    },
+    {
+        label: "Pakistan",
+        value: "Pakistan",
+    }
+]
+
+const DropdownClearSelection = (props) => {
+    const dropdownRef = useRef(null)
+
+    const handleReset = () => {
+        if (dropdownRef.current) {
+            dropdownRef.current.clearSelected()
+        }
+    }
+
+    return (
+        <>
+            <Dropdown
+                defaultValue={options[2]}
+                options={options}
+                ref={dropdownRef}
+                {...props}
+            />
+            <Button
+                marginTop="md"
+                onClick={handleReset}
+                text="Reset"
+            />
+        </>
+    )
+}
+
+export default DropdownClearSelection

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_clear_selection.md

@@ -0,0 +1 @@
+To use an external control (like a reset button) to clear Dropdown selection, you can make use of the `useRef` hook. You must pass a ref to the Dropdown component and use that ref within the onClick for the external control in the way shown in the code snippet below.

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

@@ -22,6 +22,7 @@ examples:
   - dropdown_error: Dropdown with Error
   - dropdown_default_value: Default Value
   - dropdown_blank_selection: Blank Selection
+  - dropdown_clear_selection: Clear Selection
   # - dropdown_with_autocomplete: Autocomplete
   # - dropdown_with_autocomplete_and_custom_display: Autocomplete with Custom Display
   # - dropdown_with_external_control: useDropdown Hook

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

@@ -12,3 +12,4 @@ export { default as DropdownSubcomponentStructure } from './_dropdown_subcompone
 export { default as DropdownError } from './_dropdown_error.jsx'
 export { default as DropdownDefaultValue } from './_dropdown_default_value.jsx'
 export { default as DropdownBlankSelection } from './_dropdown_blank_selection.jsx'
+export { default as DropdownClearSelection } from './_dropdown_clear_selection.jsx'

data/app/pb_kits/playbook/pb_dropdown/subcomponents/DropdownOption.tsx

@@ -62,7 +62,7 @@ const DropdownOption = (props: DropdownOptionProps) => {
   const focusedClass = isFocused && "focused";
 
   const selectedClass = `${
-    selected.label === option.label
+    selected?.label === option.label
       ? "selected"
       : "list"
   }`;

data/app/pb_kits/playbook/pb_dropdown/subcomponents/DropdownTrigger.tsx

@@ -73,7 +73,7 @@ const DropdownTrigger = (props: DropdownTriggerProps) => {
     !autocomplete && "select_only"
   );
 
-  const customDisplayPlaceholder = selected.label ? (
+  const customDisplayPlaceholder = selected?.label ? (
     <b>{selected.label}</b>
   ) : autocomplete ? (
     ""
@@ -83,7 +83,7 @@ const DropdownTrigger = (props: DropdownTriggerProps) => {
     "Select..."
   );
 
-  const defaultDisplayPlaceholder = selected.label
+  const defaultDisplayPlaceholder = selected?.label
     ? selected.label
     : autocomplete
     ? ""

data/app/pb_kits/playbook/pb_multiple_users_stacked/_multiple_users_stacked.scss

@@ -3,6 +3,76 @@
 @import "../tokens/opacity";
 @import "../pb_avatar/avatar";
 
+$sizes: (
+  "avatar": ("sm": 38px, "md": 60px, "lg": 80px, "xl": 100px),
+  "first-item-double": ("sm": 20px, "md": 32px, "lg": 44px, "xl": 56px),
+  "first-item-triple": ("sm": 16px, "md": 24px, "lg": 32px, "xl": 44px),
+  "first-item-quadruple": ("sm": 16px, "md": 28px, "lg": 36px, "xl": 44px),
+  "second-item-double": ("sm": 12px, "md": 16px, "lg": 20px, "xl": 24px),
+  "second-item-triple": ("sm": 12px, "md": 20px, "lg": 24px, "xl": 32px),
+  "second-item-quadruple": ("sm": 12px, "md": 20px, "lg": 28px, "xl": 32px),
+  "third-item-triple": ("sm": 10px, "md": 16px, "lg": 20px, "xl": 24px),
+  "third-item-quadruple": ("sm": 10px, "md": 16px, "lg": 24px, "xl": 24px),
+  "fourth-item": ("sm": 8px, "md": 12px, "lg": 16px, "xl": 16px)
+);
+
+$positions: (
+  "second-item-double": (
+    "sm": ("top": null, "bottom": 5px, "right": 4px, "left": null),
+    "md": ("top": null, "bottom": 10px, "right": 8px, "left": null),
+    "lg": ("top": 46px, "bottom": null, "right": 12px, "left": null),
+    "xl": ("top": 58px, "bottom": null, "right": 14px, "left": null)
+  ),
+  "second-item-triple": (
+    "sm": ("top": 12px, "bottom": null, "right": 2px, "left": null),
+    "md": ("top": 24px, "bottom": null, "right": 5px, "left": null),
+    "lg": ("top": 32px, "bottom": null, "right": 9px, "left": null),
+    "xl": ("top": 41px, "bottom": null, "right": 11px, "left": null)
+  ),
+  "second-item-quadruple": (
+    "sm": ("top": null, "bottom": 9px, "right": 4px, "left": null),
+    "md": ("top": 24px, "bottom": null, "right": 5px, "left": null),
+    "lg": ("top": 31px, "bottom": null, "right": 6px, "left": null),
+    "xl": ("top": 43px, "bottom": null, "right": 9px, "left": null)
+  ),
+  "third-item-triple": (
+    "sm": ("top": null, "bottom": 3px, "right": null, "left": 11px),
+    "md": ("top": null, "bottom": 6px, "right": null, "left": 16px),
+    "lg": ("top": null, "bottom": 10px, "right": null, "left": 23px),
+    "xl": ("top": null, "bottom": 13px, "right": null, "left": 27px)
+  ),
+  "third-item-quadruple": (
+    "sm": ("top": null, "bottom": 3px, "right": null, "left": 9px),
+    "md": ("top": null, "bottom": 5px, "right": null, "left": 15px),
+    "lg": ("top": null, "bottom": 7px, "right": null, "left": 20px),
+    "xl": ("top": null, "bottom": 11px, "right": null, "left": 27px)
+  ),
+  "fourth-item": (
+    "sm": ("top": 5px, "bottom": null, "right": 6px, "left": null),
+    "md": ("top": 7px, "bottom": null, "right": 12px, "left": null),
+    "lg": ("top": 9px, "bottom": null, "right": 16px, "left": null),
+    "xl": ("top": 16px, "bottom": null, "right": 24px, "left": null)
+  ),
+  "first-item-double": (
+    "sm": ("top": 4px, "bottom": null, "right": null, "left": 3px),
+    "md": ("top": 6px, "bottom": null, "right": null, "left": 8px),
+    "lg": ("top": 8px, "bottom": null, "right": null, "left": 8px),
+    "xl": ("top": 10px, "bottom": null, "right": null, "left": 10px)
+  ),
+  "first-item-triple": (
+    "sm": ("top": 4px, "bottom": null, "right": null, "left": 4px),
+    "md": ("top": 7px, "bottom": null, "right": null, "left": 7px),
+    "lg": ("top": 10px, "bottom": null, "right": null, "left": 10px),
+    "xl": ("top": 12px, "bottom": null, "right": null, "left": 12px)
+  ),
+  "first-item-quadruple": (
+    "sm": ("top": 5px, "bottom": null, "right": null, "left": 3px),
+    "md": ("top": 7px, "bottom": null, "right": null, "left": 5px),
+    "lg": ("top": 9px, "bottom": null, "right": null, "left": 7px),
+    "xl": ("top": 16px, "bottom": null, "right": null, "left": 10px)
+  )
+);
+
 @mixin avatar-size($size) {
   height: $size;
   width: $size;
@@ -27,8 +97,8 @@
   $stacked_size: 18px;
   $max_to_display: 1, 2;
   display: inline-flex;
-  width: $container_size;
-  height: $container_size;
+  width: 28px;
+  height: 28px;
   flex-basis: $container_size;
   position: relative;
   flex-shrink: 0;
@@ -48,7 +118,7 @@
     }
   }
   &[class*=_single] .pb_multiple_users_stacked_item {
-    @include avatar-size($container_size);
+    @include avatar-size(28px);
   }
   [class^=pb_avatar_kit].second_item, [class^=pb_badge_kit].second_item {
     @include position((bottom: 0, right: 0));
@@ -71,72 +141,106 @@
     color: transparent;
   }
 
-  &[class*=_bubble] {
-    @include avatar-size($bubble_container_size);
-    background-color: $bg_light;
-    border-radius: 50%;
-
-    &.dark {
-      background-color: $card_dark;
-    }
-    
-    [class^=pb_avatar_kit].pb_multiple_users_stacked_item {
-      &.dark {
-        .avatar_wrapper {
-          border: $border_size solid $border_dark;
-        }
-      }
-    }
-
-    [class^=pb_avatar_kit] {
-      &.first_item {
-        @include position((top: 4px, left: 3px));
-        @include avatar-size(20px);
-
-        &.triple_bubble {
-          @include position((top: 4px, left: 4px));
-          @include avatar-size(16px);
+  // Iterate over each size to adjust the bubble container only when class contains "_bubble_"
+  @each $size_name, $size_value in $avatar-sizes {
+      &[class*=_bubble_][class*=_size_#{$size_name}] {
+        // Set bubble container size based on the class
+        $bubble_container_size: $size_value;
+        $container_size: $size_value;
+  
+        // Apply the bubble container size
+        @include avatar-size($bubble_container_size);
+        width: $bubble_container_size;
+        height: $bubble_container_size;
+        flex-basis: $bubble_container_size;
+  
+        background-color: $bg_light;
+        border-radius: 50%;
+  
+        &.dark {
+          background-color: $card_dark;
         }
-
-        &.quadruple_bubble {
-          @include position((top: 5px, left: 3px));
-          @include avatar-size(16px);
-        }
-      }
-
-      &.second_item {
-        @include position((bottom: 5px, right: 4px));
-        @include avatar-size(12px);
-
-        &.triple_bubble {
-          @include position((top: 13px, right: 2px));
+  
+        [class^=pb_avatar_kit].pb_multiple_users_stacked_item {
+          @include avatar-size($bubble_container_size * 0.45); // Adjust the size of stacked avatars
+  
+          &.dark {
+            .avatar_wrapper {
+              border: $border_size solid $border_dark;
+            }
+          }
+  
+          .avatar_wrapper {
+            border: $border_size solid $white;
+          }
         }
-
-        &.quadruple_bubble {
-          @include position((bottom: 9px, right: 4px));
+  
+        [class^=pb_avatar_kit] {
+          // First Item
+          &.first_item {
+            @include position(map-get(map-get($positions, 'first-item-double'), $size_name));
+            @include avatar-size(map-get(map-get($sizes, 'first-item-double'), $size_name));
+        
+            &.double_bubble {
+              @include position(map-get(map-get($positions, 'first-item-double'), $size_name));
+              @include avatar-size(map-get(map-get($sizes, 'first-item-double'), $size_name));
+            }
+        
+            &.triple_bubble {
+              @include position(map-get(map-get($positions, 'first-item-triple'), $size_name));
+              @include avatar-size(map-get(map-get($sizes, 'first-item-triple'), $size_name));
+            }
+        
+            &.quadruple_bubble {
+              @include position(map-get(map-get($positions, 'first-item-quadruple'), $size_name));
+              @include avatar-size(map-get(map-get($sizes, 'first-item-quadruple'), $size_name));
+            }
+          }
+        
+          // Second Item
+          &.second_item {
+            @include position(map-get(map-get($positions, 'second-item-double'), $size_name));
+        
+            &.double_bubble {
+              @include position(map-get(map-get($positions, 'second-item-double'), $size_name));
+              @include avatar-size(map-get(map-get($sizes, 'second-item-double'), $size_name));
+            }
+        
+            &.triple_bubble {
+              @include position(map-get(map-get($positions, 'second-item-triple'), $size_name));
+              @include avatar-size(map-get(map-get($sizes, 'second-item-triple'), $size_name));
+            }
+        
+            &.quadruple_bubble {
+              @include position(map-get(map-get($positions, 'second-item-quadruple'), $size_name));
+              @include avatar-size(map-get(map-get($sizes, 'second-item-quadruple'), $size_name));
+            }
+          }
+        
+          // Third Item
+          &.third_item {
+            @include position(map-get(map-get($positions, 'third-item-triple'), $size_name));
+            @include avatar-size(map-get(map-get($sizes, 'third-item-triple'), $size_name));
+        
+            &.quadruple_bubble {
+              @include position(map-get(map-get($positions, 'third-item-quadruple'), $size_name));
+              @include avatar-size(map-get(map-get($sizes, 'third-item-quadruple'), $size_name));
+            }
+          }
+        
+          // Fourth Item
+          &.fourth_item {
+            @include position(map-get(map-get($positions, 'fourth-item'), $size_name));
+            @include avatar-size(map-get(map-get($sizes, 'fourth-item'), $size_name));
+          }
         }
-      }
-
-      &.third_item {
-        @include position((bottom: 3px, left: 11px));
-        @include avatar-size(10px);
-
-        &.quadruple_bubble {
-          @include position((bottom: 3px, left: 9px));
+        
+        &[class*=_single_bubble] {
+          [class^=pb_avatar_kit].first_item {
+            @include position((top: 0, left: 0));
+            @include avatar-size($bubble_container_size);
+          }
         }
       }
-
-      &.fourth_item {
-        @include position((top: 5px, right: 6px));
-        @include avatar-size(8px);
-      }
-    }
-  }
-
-  &[class*=_single_bubble] {
-    [class^=pb_avatar_kit].first_item {
-      @include position((top: 0, left: 0));
-      @include avatar-size($bubble_container_size);
     }
   }
-}

data/app/pb_kits/playbook/pb_multiple_users_stacked/_multiple_users_stacked.test.js

@@ -81,7 +81,7 @@ const MultipleUsersStackedSingleBubble = () => {
 test('should have a single bubble', () => {
     render(<MultipleUsersStackedSingleBubble />)
     const kit = screen.getByTestId(testId)
-    expect(kit).toHaveClass("pb_multiple_users_stacked_kit_single_bubble")
+    expect(kit).toHaveClass("pb_multiple_users_stacked_kit_single_bubble_size_sm")
 
     const firstItem = kit.querySelector('.first_item');
     expect(firstItem).toBeInTheDocument();
@@ -113,7 +113,7 @@ const MultipleUsersStackedDoubleBubble = () => {
 test('should have a double bubble', () => {
     render(<MultipleUsersStackedDoubleBubble />)
     const kit = screen.getByTestId(testId)
-    expect(kit).toHaveClass("pb_multiple_users_stacked_kit_bubble")
+    expect(kit).toHaveClass("pb_multiple_users_stacked_kit_bubble_size_sm")
 
     const firstItem = kit.querySelector('.first_item');
     expect(firstItem).toBeInTheDocument();
@@ -153,7 +153,7 @@ const MultipleUsersStackedTripleBubble = () => {
 test('should have a triple bubble', () => {
     render(<MultipleUsersStackedTripleBubble />)
     const kit = screen.getByTestId(testId)
-    expect(kit).toHaveClass("pb_multiple_users_stacked_kit_bubble")
+    expect(kit).toHaveClass("pb_multiple_users_stacked_kit_bubble_size_sm")
 
     const firstItem = kit.querySelector('.first_item');
     expect(firstItem).toBeInTheDocument();
@@ -208,7 +208,7 @@ const MultipleUsersStackedQuadrupleBubble = () => {
 test('should have a quadruple bubble', () => {
     render(<MultipleUsersStackedQuadrupleBubble />)
     const kit = screen.getByTestId(testId)
-    expect(kit).toHaveClass("pb_multiple_users_stacked_kit_bubble")
+    expect(kit).toHaveClass("pb_multiple_users_stacked_kit_bubble_size_sm")
 
     const firstItem = kit.querySelector('.first_item');
     expect(firstItem).toBeInTheDocument();
@@ -224,4 +224,4 @@ test('should have a quadruple bubble', () => {
 
     const fourthItem = kit.querySelector('.fourth_item');
     expect(fourthItem).toBeInTheDocument();
-})
+})

data/app/pb_kits/playbook/pb_multiple_users_stacked/_multiple_users_stacked.tsx

@@ -14,6 +14,7 @@ type MultipleUsersStackedProps = {
   data?: { [key: string]: string },
   htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string,
+  size?: "md" | "lg" | "sm" | "xl" 
   users: Array<{ [key: string]: string }>,
   variant: "default" | "bubble",
 }
@@ -27,14 +28,17 @@ const MultipleUsersStacked = (props: MultipleUsersStackedProps) => {
     htmlOptions = {},
     id,
     users,
+    size = "sm",
     variant = "default",
   } = props
 
   const moreThanTwo = users.length > 2
   const onlyOne = users.length == 1
   const isBubble = variant === "bubble"
+  const doubleBubble = isBubble && users.length === 2
   const tripleBubble = isBubble && users.length === 3
   const quadrupleBubble = isBubble && users.length > 3
+  const sizeClass = isBubble ? `size_${size}` : ""  
   const displayCount = () => {
     return moreThanTwo ? 1 : users.length
   }
@@ -43,17 +47,19 @@ const MultipleUsersStacked = (props: MultipleUsersStackedProps) => {
   const htmlProps = buildHtmlProps(htmlOptions)
   const classes = classnames(buildCss(
     'pb_multiple_users_stacked_kit',
-    { single: onlyOne, bubble: isBubble }), globalProps(props), className)
+    { single: onlyOne, bubble: isBubble }, sizeClass),
+    globalProps(props),
+    className)
 
   const firstUser = () => {
     return users.slice(0, 1).map((userObject, index) => {
       return (
         <Avatar
             {...userObject}
-            className={`pb_multiple_users_stacked_item first_item${tripleBubble ? " triple_bubble" : ""}${quadrupleBubble ? " quadruple_bubble" : ""}`}
+            className={`pb_multiple_users_stacked_item first_item ${doubleBubble ? "double_bubble" : ""}${tripleBubble ? " triple_bubble" : ""}${quadrupleBubble ? " quadruple_bubble" : ""}`}
             dark={dark}
             key={index}
-            size={isBubble ? "sm" : "xs"}
+            size={isBubble ? "md" : "xs"}
         />
       )
     })
@@ -65,10 +71,10 @@ const MultipleUsersStacked = (props: MultipleUsersStackedProps) => {
         return (
           <Avatar
               {...userObject}
-              className={`pb_multiple_users_stacked_item second_item${tripleBubble ? " triple_bubble" : ""}${quadrupleBubble ? " quadruple_bubble" : ""}`}
+              className={`pb_multiple_users_stacked_item second_item ${doubleBubble ? "double_bubble" : ""}${tripleBubble ? " triple_bubble" : ""}${quadrupleBubble ? " quadruple_bubble" : ""}`}
               dark={dark}
               key={index}
-              size="xs"
+              size={isBubble ? "md" : "xs"}
           />
         )
       })
@@ -81,10 +87,10 @@ const MultipleUsersStacked = (props: MultipleUsersStackedProps) => {
         return (
           <Avatar
               {...userObject}
-              className={`pb_multiple_users_stacked_item third_item${quadrupleBubble ? " quadruple_bubble" : ""}`}
+              className={`pb_multiple_users_stacked_item third_item ${doubleBubble ? "double_bubble" : ""}${tripleBubble ? " triple_bubble" : ""}${quadrupleBubble ? " quadruple_bubble" : ""}`}
               dark={dark}
               key={index}
-              size="xs"
+              size="md"
           />
         )
       })
@@ -97,10 +103,10 @@ const MultipleUsersStacked = (props: MultipleUsersStackedProps) => {
         return (
           <Avatar
               {...userObject}
-              className="pb_multiple_users_stacked_item fourth_item"
+              className="pb_multiple_users_stacked_item fourth_item quadruple_bubble"
               dark={dark}
               key={index}
-              size="xs"
+              size="md"
           />
         )
       })