playbook_ui 13.25.0 → 13.26.0.pre.alpha.PBNTR291Dropdownrailsv22840

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

@@ -5,46 +5,51 @@
 @import "../tokens/shadows";
 @import "../tokens/positioning";
 @import "../pb_body/body_mixins";
+@import "../pb_textarea/textarea_mixin";
+
+@import "./scss_partials/dropdown_animation";
 
 .pb_dropdown {
   .dropdown_wrapper {
-    position: relative;
-    .dropdown_trigger_wrapper {
+    [class*="dropdown_trigger_wrapper"] {
       @include pb_body;
       border: 1px solid $border_light;
       background-color: $white;
-      box-shadow: inset 0 -11px 20px rgba($primary, 0.05);
+      height: 45px;
       @media (hover: hover) {
         &:hover,
         &:active,
         &:focus {
           background-color: $focus_input_light;
-        }
-        input {
-          background-color: $focus_input_light;
+          input {
+            background-color: $focus_input_light;
+          }
         }
       }
 
       .dropdown_input {
         @include pb_body;
         border: unset;
-        border-radius: $border_rad_heavier;
         padding: 0;
-
+        background-color: $white;
         &:focus-visible {
           outline: none;
         }
       }
       &:focus {
-        box-shadow: 0px 0px 0 1px $primary;
+        box-shadow: 0px 0px 0 1px $primary !important;
         outline: unset;
         transition: box-shadow 0.15s ease-in-out;
       }
-    }
 
-    .dropdown_trigger_wrapper_focus {
-      box-shadow: 0px 0px 0 1px $primary;
-      transition: box-shadow .10s ease-in-out;
+      &[class*="_select_only"] {
+        box-shadow: inset 0 -11px 20px rgba($primary, 0.05);
+      }
+
+      &[class*="_focus"] {
+        box-shadow: 0px 0px 0 1px $primary !important;
+        transition: box-shadow 0.1s ease-in-out;
+      }
     }
 
     .pb_dropdown_container {
@@ -54,45 +59,107 @@
       border-radius: $border_rad_heavier;
       border: 1px solid $border_light;
       margin-top: $space_xs;
-      position: absolute;
       z-index: $z_1;
       width: 100%;
-      transition: opacity 0.25s ease-in-out;
 
-      .pb_dropdown_option {
-        :hover {
+      [class*="pb_dropdown_option"] {
+        cursor: pointer;
+        &:hover {
           background-color: $border_light;
         }
-      }
-
-      .dropdown_option_focused {
-        background-color: $border_light;
-      }
 
-      .dropdown_option {
-        width: 100%;
-      }
+        &[class*="_focused"] {
+          background-color: $border_light;
+        }
 
-      .dropdown_option_list {
-        border-bottom: 1px solid $border_light;
-      }
-      .dropdown_option_selected {
-        background-color: $primary;
-        [class^="pb_body"],
-        [class^="pb_title_kit"] {
-          color: $white !important;
+        &[class*="_list"] {
+          border-bottom: 1px solid $border_light;
         }
-        :hover {
-          background-color: unset;
+        &[class*="selected"] {
+          background-color: $primary;
+          color: $white;
+          [class^="pb_body"],
+          [class^="pb_title_kit"], a {
+            color: $white !important;
+          }
+          &:hover {
+            background-color: $primary !important;
+          }
         }
       }
+
+      .dropdown_option_wrapper {
+        width: 100%;
+      }
     }
     .close {
       display: none;
+      animation-name: fadeOut;
+      animation-duration: 150ms;
+      animation-timing-function: linear;
+      animation-fill-mode: forwards;
     }
 
     .open {
       display: block;
+      animation-name: fadeIn;
+      animation-duration: 150ms;
+      animation-timing-function: linear;
+      animation-fill-mode: forwards;
+    }
+  }
+
+  &.dark {
+    .dropdown_wrapper {
+      [class*="dropdown_trigger_wrapper"] {
+        @include pb_body_light_dark;
+        background-color: rgba($white, 0.1) !important;
+        background: none;
+        border-color: rgba($white, 0.15);
+        @media (hover: hover) {
+          &:hover,
+          &:active,
+          &:focus {
+            background-color: rgba($white, 0.05) !important;
+          }
+        }
+        [class^="pb_body"] {
+          color: $white;
+        }
+        &[class*="_select_only"] {
+          box-shadow: inset 0 -11px 20px rgba($white, 0.05);
+        }
+        .dropdown_input {
+          background-color: unset;
+          color: $white;
+        }
+      }
+    }
+    .pb_dropdown_container {
+      background-color: $bg_dark !important;
+      border-color: rgba($white, 0.15);
+      color: $white;
+      [class^="pb_body"],
+      [class^="pb_title_kit"] {
+        color: $white !important;
+      }
+
+      [class*="pb_dropdown_option"] {
+        &:hover {
+          background-color: $hover_dark;
+        }
+
+        &[class*="_focused"] {
+          background-color: $hover_dark;
+        }
+
+        &[class*="_list"] {
+          border-color: rgba($white, 0.15);
+        }
+        &[class*="selected"] {
+          background-color: $primary;
+        }
+      }
     }
   }
 }

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

@@ -1,31 +1,38 @@
-import React, { useState, useRef, useEffect, ReactElement } from "react";
+import React, { useState, useRef, useEffect } from "react";
 import classnames from "classnames";
-import { buildAriaProps, buildCss, buildDataProps } from "../utilities/props";
+import { buildAriaProps, buildCss, buildDataProps, buildHtmlProps } from "../utilities/props";
 import { globalProps } from "../utilities/globalProps";
+import { GenericObject } from "../types";
 
 import Body from "../pb_body/_body";
+import Caption from "../pb_caption/_caption";
 
 import DropdownContainer from "./subcomponents/DropdownContainer";
+import DropdownContext from "./context";
 import DropdownOption from "./subcomponents/DropdownOption";
 import DropdownTrigger from "./subcomponents/DropdownTrigger";
-import DropdownContext from "./context";
 import useDropdown from "./hooks/useDropdown";
 
 import {
   separateChildComponents,
   prepareSubcomponents,
-} from "./utilities/subComponentHelper";
-import { GenericObject } from "../types";
+  handleClickOutside,
+} from "./utilities";
 
 type DropdownProps = {
   aria?: { [key: string]: string };
   autocomplete?: boolean;
+  children?: React.ReactChild[] | React.ReactChild | React.ReactElement[];
   className?: string;
+  dark?: boolean;
   data?: { [key: string]: string };
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string;
-  children?: React.ReactChild[] | React.ReactChild | ReactElement[];
-  options: GenericObject;
+  isClosed?: boolean;
+  label?: string;
   onSelect?: (arg: GenericObject) => null;
+  options: GenericObject;
+  triggerRef?: any;
 };
 
 const Dropdown = (props: DropdownProps) => {
@@ -34,49 +41,66 @@ const Dropdown = (props: DropdownProps) => {
     autocomplete = false,
     children,
     className,
+    dark = false,
     data = {},
+    htmlOptions = {},
     id,
-    options,
+    isClosed = true,
+    label,
     onSelect,
+    options,
+    triggerRef
   } = props;
 
   const ariaProps = buildAriaProps(aria);
   const dataProps = buildDataProps(data);
+  const htmlProps = buildHtmlProps(htmlOptions);
   const classes = classnames(
     buildCss("pb_dropdown"),
     globalProps(props),
     className
   );
 
-  const [isDropDownClosed, setIsDropDownClosed, toggleDropdown] = useDropdown();
+  const [isDropDownClosed, setIsDropDownClosed, toggleDropdown] = useDropdown(isClosed);
 
   const [filterItem, setFilterItem] = useState("");
-  const [selected, setSelected] = useState({});
+  const [selected, setSelected] = useState<GenericObject>({});
   const [isInputFocused, setIsInputFocused] = useState(false);
   const [hasTriggerSubcomponent, setHasTriggerSubcomponent] = useState(true);
   const [hasContainerSubcomponent, setHasContainerSubcomponent] =
     useState(true);
-
   //state for keyboard events
   const [focusedOptionIndex, setFocusedOptionIndex] = useState(-1);
 
   const dropdownRef = useRef(null);
   const inputRef = useRef(null);
+  const inputWrapperRef = useRef(null);
+  const dropdownContainerRef = useRef(null);
 
   const { trigger, container, otherChildren } =
     separateChildComponents(children);
 
-  // useEffect to handle clicks outside the dropdown
   useEffect(() => {
-    const handleClickOutside = (e: MouseEvent) => {
-      if (dropdownRef.current && !dropdownRef.current.contains(e.target)) {
-        setIsDropDownClosed(true);
-        setIsInputFocused(false);
+    // Set the parent element of the trigger to relative to allow for absolute positioning of the dropdown
+    //Only needed for when useDropdown hook used with external trigger
+    if (triggerRef?.current) {
+      const parentElement = triggerRef.current.parentNode;
+      if (parentElement) {
+          parentElement.style.position = 'relative';
       }
-    };
-    window.addEventListener("click", handleClickOutside);
+  }
+  // Handle clicks outside the dropdown
+  const handleClick = handleClickOutside({
+    inputWrapperRef,
+    dropdownContainerRef,
+    setIsDropDownClosed,
+    setFocusedOptionIndex,
+    setIsInputFocused,
+  });
+  
+    window.addEventListener("click", handleClick);
     return () => {
-      window.removeEventListener("click", handleClickOutside);
+      window.removeEventListener("click", handleClick);
     };
   }, []);
 
@@ -85,6 +109,32 @@ const Dropdown = (props: DropdownProps) => {
     setHasContainerSubcomponent(!!container);
   }, []);
 
+// dropdown to toggle with external control
+  useEffect(()=> {
+    setIsDropDownClosed(isClosed)
+   },[isClosed])
+
+  const filteredOptions = options?.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(() => {
+    if (!isDropDownClosed) { 
+        let newIndex = 0; 
+        if (selected && selected?.label) {
+            const selectedIndex = filteredOptions.findIndex((option: GenericObject) => option.label === selected.label);
+            if (selectedIndex >= 0) {
+                newIndex = selectedIndex;
+            }
+        }
+        setFocusedOptionIndex(newIndex);
+    }
+}, [isDropDownClosed]);
+
+
   const handleChange = (e: React.ChangeEvent<HTMLInputElement>) => {
     setFilterItem(e.target.value);
     setIsDropDownClosed(false);
@@ -94,7 +144,7 @@ const Dropdown = (props: DropdownProps) => {
     setSelected(selectedItem);
     setFilterItem("");
     setIsDropDownClosed(true);
-    onSelect(selectedItem);
+    onSelect && onSelect(selectedItem);
   };
 
   const handleWrapperClick = () => {
@@ -104,14 +154,10 @@ const Dropdown = (props: DropdownProps) => {
 
   const handleBackspace = () => {
     setSelected({});
-    onSelect(null);
+    onSelect && onSelect(null);
     setFocusedOptionIndex(-1);
   };
 
-  const filteredOptions = options?.filter((option: GenericObject) =>
-    option.label.toLowerCase().includes(filterItem.toLowerCase())
-  );
-
   const componentsToRender = prepareSubcomponents({
     children,
     hasTriggerSubcomponent,
@@ -119,17 +165,22 @@ const Dropdown = (props: DropdownProps) => {
     trigger,
     container,
     otherChildren,
+    dark
   });
 
+
   return (
     <div {...ariaProps} 
         {...dataProps} 
+        {...htmlProps}
         className={classes} 
         id={id}
+        style={triggerRef ? { position: "absolute"} : { position: "relative"}}
     >
       <DropdownContext.Provider
           value={{
               autocomplete,
+              dropdownContainerRef,
               filteredOptions,
               filterItem,
               focusedOptionIndex,
@@ -138,6 +189,7 @@ const Dropdown = (props: DropdownProps) => {
               handleOptionClick,
               handleWrapperClick,
               inputRef,
+              inputWrapperRef,
               isDropDownClosed,
               isInputFocused,
               options,
@@ -147,9 +199,26 @@ const Dropdown = (props: DropdownProps) => {
               setIsInputFocused,
               setSelected,
               toggleDropdown,
+              triggerRef
           }}
       >
+        {label &&
+        <Caption
+            dark={dark}
+            marginBottom="xs"
+            text={label}
+        />
+        }
         <div className="dropdown_wrapper" 
+            onBlur={() => {
+                // Debounce to delay the execution to prevent jumpiness in Focus state
+                setTimeout(() => {
+                    if (!dropdownRef.current.contains(document.activeElement)) {
+                        setIsInputFocused(false);
+                    }
+                }, 0);
+            }}
+            onFocus={() => setIsInputFocused(true)}
             ref={dropdownRef}
         >
           {children ? (
@@ -176,7 +245,7 @@ const Dropdown = (props: DropdownProps) => {
         </div>
       </DropdownContext.Provider>
     </div>
-  );
+  )
 };
 
 Dropdown.Option = DropdownOption;

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_default.html.erb

@@ -0,0 +1,10 @@
+<% 
+  options = [
+    { label: 'United States', value: 'United States', id: 'us' },
+    { label: 'Canada', value: 'Canada', id: 'ca' },
+    { label: 'Pakistan', value: 'Pakistan', id: 'pk' },
+  ]
+
+%>
+
+<%= pb_rails("dropdown", props: {options: options}) %>

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

@@ -1,31 +1,20 @@
-import React, { useState } from 'react'
+import React from 'react'
 import { Dropdown } from '../../'
 
 const DropdownDefault = (props) => {
-// eslint-disable-next-line no-unused-vars
-const [selectedOption, setSelectedOption] = useState();
 
   const options = [
     {
       label: "United States",
       value: "United States",
-      areaCode: "+1",
-      icon: "🇺🇸",
-      id: "United-states"
     },
     {
-      label: "Ukraine",
-      value: "Ukraine",
-      areaCode: "+380",
-      icon: "🇺🇦",
-      id: "ukraine"
+      label: "Canada",
+      value: "Canada",
     },
     {
       label: "Pakistan",
       value: "Pakistan",
-      areaCode: "+92",
-      icon: "🇵🇰",
-      id: "pakistan"
     }
   ];  
 
@@ -33,16 +22,9 @@ const [selectedOption, setSelectedOption] = useState();
   return (
   <div>
     <Dropdown
-        onSelect={(selectedItem) => setSelectedOption(selectedItem)}
         options={options}
         {...props}
-    >
-      {options.map((option) => (
-        <Dropdown.Option key={option.id} 
-            option={option}
-        /> 
-      ))}
-    </Dropdown>
+    />
   </div>
   )
 }

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

@@ -0,0 +1 @@
+The Dropdown kit accepts an `options` array and renders each object from that array as a selectable option within a dropdown container. `options` is a required prop and must be an array of objects. Each object can contain as many key/value pairs as needed but MUST contain 'label' and 'value' as the only required items within each object.

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_subcomponent_structure.html.erb

@@ -0,0 +1,17 @@
+<% 
+  options = [
+    { label: 'United States', value: 'United States', id: 'us' },
+    { label: 'Canada', value: 'Canada', id: 'ca' },
+    { label: 'Pakistan', value: 'Pakistan', id: 'pk' },
+  ]
+
+%>
+
+<%= pb_rails("dropdown", props: {options: options}) do %>
+    <%= pb_rails("dropdown/dropdown_trigger") %>
+    <%= pb_rails("dropdown/dropdown_container") do %>
+        <% options.each do |option| %>
+            <%= pb_rails("dropdown/dropdown_option", props: {option: option}) %>
+        <% end %>
+    <% end %>
+<% end %>

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

@@ -0,0 +1,42 @@
+import React from 'react'
+import { Dropdown } from '../..'
+
+const DropdownSubcomponentStructure = (props) => {
+
+
+  const options = [
+    {
+      label: "United States",
+      value: "United States",
+    },
+    {
+      label: "Canada",
+      value: "Canada",
+    },
+    {
+      label: "Pakistan",
+      value: "Pakistan",
+    }
+  ];  
+
+
+  return (
+  <div>
+    <Dropdown
+        options={options}
+        {...props}
+    >
+      <Dropdown.Trigger/>
+      <Dropdown.Container>
+        {options.map((option) => (
+          <Dropdown.Option key={option.id} 
+              option={option}
+          />
+        ))}
+      </Dropdown.Container>
+    </Dropdown>
+  </div>
+  )
+}
+
+export default  DropdownSubcomponentStructure

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

@@ -0,0 +1,7 @@
+The dropdown comes with the following subcomponents that can be used to achieve various levels of customization:
+
+`Dropdown. Trigger` / `dropdown/dropdown_trigger`
+`Dropdown.Container`/ `dropdown/dropdown_container`
+`Dropdown.Option` / `dropdown/dropdown_option`
+
+See the code snippet below for a visual on how to use the kit with subcomponents. Each subcomponent allows for GlobalProps in addition to any subcomponent specfic props. 

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

@@ -0,0 +1,84 @@
+import React from 'react'
+import { Dropdown, User, Badge, FlexItem } from '../..'
+
+const DropdownWithAutocomplete = (props) => {
+
+  const options = [
+    {
+      label: "Jasper Furniss",
+      value: "Jasper Furniss",
+      territory: "PHL",
+      title: "Senior UX Engineer",
+      id: "jasper-furniss",
+      status: "Offline"
+    },
+    {
+      label: "Ramon Ruiz",
+      value: "Ramon Ruiz",
+      territory: "PHL",
+      title: "Senior UX Designer",
+      id: "ramon-ruiz",
+      status: "Away"
+    },
+    {
+      label: "Jason Cypret",
+      value: "Jason Cypret",
+      territory: "PHL",
+      title: "VP of User Experience",
+      id: "jason-cypret",
+      status: "Online"
+    },
+    {
+      label: "Courtney Long",
+      value: "Courtney Long",
+      territory: "PHL",
+      title: "UX Design Mentor",
+      id: "courtney-long",
+      status: "Online"
+    }
+  ];
+
+
+  return (
+  <div>
+    <Dropdown autocomplete
+        options={options}
+        {...props}
+    >
+        {options.map((option) => (
+          <Dropdown.Option key={option.id} 
+              option={option}
+          >
+            <>
+              <FlexItem>
+                <User
+                    align="left"
+                    avatar
+                    name={option.label}
+                    orientation="horizontal"
+                    territory={option.territory}
+                    title={option.title}
+                />
+              </FlexItem>
+              <FlexItem>
+                <Badge
+                    rounded
+                    text={option.status}
+                    variant={`${
+                        option.status === "Offline"
+                        ? "neutral"
+                        : option.status === "Online"
+                        ? "success"
+                        : "warning"
+                    }`}
+                />
+              </FlexItem>
+            </>
+          </Dropdown.Option>
+        ))}
+    </Dropdown>
+  </div>
+  )
+}
+
+export default  DropdownWithAutocomplete

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

@@ -0,0 +1 @@
+The `autocomplete` prop can be used to add autocomplete or typeahead functionality to the Dropdown's default Trigger. This prop is set to 'false' by default.