playbook_ui 12.26.1.pre.alpha.railsmultilevelimprovements842 → 12.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 326f8eff50b791dc21ab3ec0bdb295adef8d14d3957277f4f92d8abdfe445686
-  data.tar.gz: 0a9d5b6672174df0cb045cc3aea6b017d0e30f1a978df27e0529b7f1d3cb3472
+  metadata.gz: 7fbc9b56c02a9915257f3a1169f85773e8a063c14de44a2492a250f9015dee65
+  data.tar.gz: f70c024e4feae26b0767595ad538df87eb08e78453a56c6ca22de07552d60d5d
 SHA512:
-  metadata.gz: 1b079256265e6bcdea4576a6930b527b944044f0064936376278147aad59cf1a5b311ba25632ca3878bb50e3fd62a33ccdf17cf805d7dd60eaece7d5d3e640fe
-  data.tar.gz: fa05822858223b65f2a3a2755a1f7fcecea6946d7a1f31ea40a32ad10ebd5b3df128cc3736fdab16b6329ba283e50d201412a8d79c6027745a646d8c6c94ac05
+  metadata.gz: e40a155458785168e1fb5f5f63efe8c5bcd7dca3d1b8c618557d86453d5008336454d205330742fc029e6593e05e566610eb853577b42a993934eeb20408ffa5
+  data.tar.gz: 9acc8dcd73190cc433572b49bdef61cb4e425304125aaf8d5b61c7426f5f4c2a314f1e2b38e9b55a5f37b6f45b56cb8079ec9b82070c461699ae9b2357689a2d

data/app/pb_kits/playbook/pb_multi_level_select/_multi_level_select.tsx

@@ -1,12 +1,12 @@
-import React, { useState, useEffect, useRef } from "react"
-import classnames from "classnames"
-import { globalProps, GlobalProps } from "../utilities/globalProps"
-import { buildAriaProps, buildCss, buildDataProps } from "../utilities/props"
-import Checkbox from "../pb_checkbox/_checkbox"
-import Icon from "../pb_icon/_icon"
-import FormPill from "../pb_form_pill/_form_pill"
-import CircleIconButton from "../pb_circle_icon_button/_circle_icon_button"
-import { cloneDeep } from "lodash"
+import React, { useState, useEffect, useRef } from "react";
+import classnames from "classnames";
+import { buildAriaProps, buildCss, buildDataProps } from "../utilities/props";
+import { globalProps, GlobalProps } from "../utilities/globalProps";
+import Icon from "../pb_icon/_icon";
+import Checkbox from "../pb_checkbox/_checkbox";
+import FormPill from "../pb_form_pill/_form_pill";
+import CircleIconButton from "../pb_circle_icon_button/_circle_icon_button";
+import { cloneDeep } from "lodash";
 
 import {
   getAncestorsOfUnchecked,
@@ -15,18 +15,17 @@ import {
   getCheckedItems,
   getDefaultCheckedItems,
   recursiveCheckParent,
-} from "./_helper_functions"
+} from "./_helper_functions";
 
 type MultiLevelSelectProps = {
-  aria?: { [key: string]: string }
-  className?: string
-  data?: { [key: string]: string }
-  id?: string
-  name?: string
-  returnAllSelected?: boolean
-  treeData?: { [key: string]: string }[]
-  onSelect?: (prop: { [key: string]: any }) => void
-} & GlobalProps
+  aria?: { [key: string]: string };
+  className?: string;
+  data?: { [key: string]: string };
+  id?: string;
+  returnAllSelected?: boolean;
+  treeData?: { [key: string]: string }[];
+  onSelect?: (prop: { [key: string]: any }) => void;
+} & GlobalProps;
 
 const MultiLevelSelect = (props: MultiLevelSelectProps) => {
   const {
@@ -34,74 +33,71 @@ const MultiLevelSelect = (props: MultiLevelSelectProps) => {
     className,
     data = {},
     id,
-    name,
     returnAllSelected = false,
     treeData,
     onSelect = () => {},
-  } = props
+  } = props;
 
-  const ariaProps = buildAriaProps(aria)
-  const dataProps = buildDataProps(data)
+  const ariaProps = buildAriaProps(aria);
+  const dataProps = buildDataProps(data);
   const classes = classnames(
     buildCss("pb_multi_level_select"),
     globalProps(props),
     className
-  )
-
-  const dropdownRef = useRef(null)
+  );
 
+  const dropdownRef = useRef(null);
 
   //state for expanded property
-  const [expanded, setExpanded] = useState([])
+  const [expanded, setExpanded] = useState([]);
   //state for whether dropdown is open or closed
-  const [isClosed, setIsClosed] = useState(true)
+  const [isClosed, setIsClosed] = useState(true);
   //state from onchange for textinput, to use for filtering to create typeahead
-  const [filterItem, setFilterItem] = useState("")
+  const [filterItem, setFilterItem] = useState("");
   //this is essentially the return that the user will get when they use the kit
-  const [returnedArray, setReturnedArray] = useState([])
+  const [returnedArray, setReturnedArray] = useState([]);
   //formattedData with checked and parent_id added
-  const [formattedData, setFormattedData] = useState([])
+  const [formattedData, setFormattedData] = useState([]);
   //state for return for default
-  const [defaultReturn, setDefaultReturn] = useState([])
-
+  const [defaultReturn, setDefaultReturn] = useState([]);
 
   useEffect(() => {
-    setFormattedData(addCheckedAndParentProperty(treeData))
-  }, [treeData])
+    setFormattedData(addCheckedAndParentProperty(treeData));
+  }, [treeData]);
 
   useEffect(() => {
     if (returnAllSelected) {
-      setReturnedArray(getCheckedItems(formattedData))
+      setReturnedArray(getCheckedItems(formattedData));
     } else {
-      setDefaultReturn(getDefaultCheckedItems(formattedData))
+      setDefaultReturn(getDefaultCheckedItems(formattedData));
     }
-  }, [formattedData])
+  }, [formattedData]);
 
   useEffect(() => {
     // Function to handle clicks outside the dropdown
     const handleClickOutside = (event: any) => {
       if (dropdownRef.current && !dropdownRef.current.contains(event.target)) {
-        setIsClosed(true)
+        setIsClosed(true);
       }
-    }
+    };
     // Attach the event listener
-    window.addEventListener("click", handleClickOutside)
+    window.addEventListener("click", handleClickOutside);
     // Clean up the event listener on unmount
     return () => {
-      window.removeEventListener("click", handleClickOutside)
-    }
-  }, [])
+      window.removeEventListener("click", handleClickOutside);
+    };
+  }, []);
 
   const modifyRecursive = (tree: { [key: string]: any }[], check: boolean) => {
     if (!Array.isArray(tree)) {
-      return
+      return;
     }
     return tree.map((item: { [key: string]: any }) => {
-      item.checked = check
-      item.children = modifyRecursive(item.children, check)
-      return item
-    })
-  }
+      item.checked = check;
+      item.children = modifyRecursive(item.children, check);
+      return item;
+    });
+  };
 
   //iterate over tree, find item and set checked or unchecked
   const modifyValue = (
@@ -110,48 +106,48 @@ const MultiLevelSelect = (props: MultiLevelSelectProps) => {
     check: boolean
   ) => {
     if (!Array.isArray(tree)) {
-      return
+      return;
     }
     return tree.map((item: any) => {
-      if (item.id != id) item.children = modifyValue(id, item.children, check)
+      if (item.id != id) item.children = modifyValue(id, item.children, check);
       else {
-        item.checked = check
-        item.children = modifyRecursive(item.children, check)
+        item.checked = check;
+        item.children = modifyRecursive(item.children, check);
       }
 
-      return item
-    })
-  }
+      return item;
+    });
+  };
 
   //clone tree, check items + children
   const checkItem = (item: { [key: string]: any }) => {
-    const tree = cloneDeep(formattedData)
+    const tree = cloneDeep(formattedData);
     if (returnAllSelected) {
-      return modifyValue(item.id, tree, true)
+      return modifyValue(item.id, tree, true);
     } else {
-      const checkedTree = modifyValue(item.id, tree, true)
-      return recursiveCheckParent(item, checkedTree)
+      const checkedTree = modifyValue(item.id, tree, true);
+      return recursiveCheckParent(item, checkedTree);
     }
-  }
+  };
 
   //clone tree, uncheck items + children
   const unCheckItem = (item: { [key: string]: any }) => {
-    const tree = cloneDeep(formattedData)
+    const tree = cloneDeep(formattedData);
     if (returnAllSelected) {
-      return modifyValue(item.id, tree, false)
+      return modifyValue(item.id, tree, false);
     } else {
-      const uncheckedTree = modifyValue(item.id, tree, false)
-      return getAncestorsOfUnchecked(uncheckedTree, item)
+      const uncheckedTree = modifyValue(item.id, tree, false);
+      return getAncestorsOfUnchecked(uncheckedTree, item);
     }
-  }
+  };
 
   //setformattedData with proper properties
   const changeItem = (item: { [key: string]: any }, check: boolean) => {
-    const tree = check ? checkItem(item) : unCheckItem(item)
-    setFormattedData(tree)
+    const tree = check ? checkItem(item) : unCheckItem(item);
+    setFormattedData(tree);
 
-    return tree
-  }
+    return tree;
+  };
 
   //function to map over data and add parent_id + depth property to each item
   const addCheckedAndParentProperty = (
@@ -160,86 +156,87 @@ const MultiLevelSelect = (props: MultiLevelSelectProps) => {
     depth: number = 0
   ) => {
     if (!Array.isArray(treeData)) {
-      return
+      return;
     }
     return treeData.map((item: { [key: string]: any } | any) => {
       const newItem = {
         ...item,
         parent_id,
         depth,
-      }
+      };
       if (newItem.children && newItem.children.length > 0) {
         const children =
           item.checked && !returnAllSelected
             ? modifyRecursive(item.children, true)
-            : item.children
+            : item.children;
         newItem.children = addCheckedAndParentProperty(
           children,
           newItem.id,
           depth + 1
-        )
+        );
       }
-      return newItem
-    })
-  }
+      return newItem;
+    });
+  };
 
   //click event for x on form pill
   const handlePillClose = (event: any, clickedItem: { [key: string]: any }) => {
     // prevents the dropdown from closing when clicking on the pill
-    event.stopPropagation()
-    const updatedTree = changeItem(clickedItem, false)
+    event.stopPropagation();
+    const updatedTree = changeItem(clickedItem, false);
     //logic for removing items from returnArray or defaultReturn when pills clicked
     if (returnAllSelected) {
-      onSelect(getCheckedItems(updatedTree))
+      onSelect(getCheckedItems(updatedTree));
     } else {
-      onSelect(getDefaultCheckedItems(updatedTree))
+      onSelect(getDefaultCheckedItems(updatedTree));
     }
-  }
+  };
 
   //handle click on input wrapper(entire div with pills, typeahead, etc) so it doesn't close when input or form pill is clicked
   const handleInputWrapperClick = (e: any) => {
-    e.stopPropagation()
+    e.stopPropagation();
     if (
       e.target.id === "multiselect_input" ||
       e.target.classList.contains("pb_form_pill_tag")
     ) {
-      return
+      return;
     }
-    setIsClosed(!isClosed)
-  }
+    setIsClosed(!isClosed);
+  };
 
   //Main function to handle any click inside dropdown
   const handledropdownItemClick = (e: any, check: boolean) => {
-    const clickedItem = e.target.parentNode.id
+    const clickedItem = e.target.parentNode.id;
     //setting filterItem to "" will clear textinput and clear typeahead
-    setFilterItem("")
+    setFilterItem("");
 
-    const filtered = filterFormattedDataById(formattedData, clickedItem)
-    const updatedTree = changeItem(filtered[0], check)
+    const filtered = filterFormattedDataById(formattedData, clickedItem);
+    const updatedTree = changeItem(filtered[0], check);
+    console.log(updatedTree);
     if (returnAllSelected) {
-      onSelect(getCheckedItems(updatedTree))
+      onSelect(getCheckedItems(updatedTree));
     } else {
-      onSelect(getDefaultCheckedItems(updatedTree))
+      onSelect(getDefaultCheckedItems(updatedTree));
     }
-  }
+  };
 
-  const isExpanded = (item: any) => expanded.indexOf(item.id) > -1
+  const isExpanded = (item: any) => expanded.indexOf(item.id) > -1;
 
   //handle click on chevron toggles in dropdown
   const handleToggleClick = (id: string, event: React.MouseEvent) => {
-    event.stopPropagation()
-    const clickedItem = filterFormattedDataById(formattedData, id)
+    event.stopPropagation();
+    const clickedItem = filterFormattedDataById(formattedData, id);
     if (clickedItem) {
-      let expandedArray = [...expanded]
-      const itemExpanded = isExpanded(clickedItem[0])
+      let expandedArray = [...expanded];
+      const itemExpanded = isExpanded(clickedItem[0]);
 
       if (itemExpanded)
-        expandedArray = expandedArray.filter((i) => i != clickedItem[0].id)
-      else expandedArray.push(clickedItem[0].id)
+        expandedArray = expandedArray.filter((i) => i != clickedItem[0].id);
+      else expandedArray.push(clickedItem[0].id);
 
-      setExpanded(expandedArray)
+      setExpanded(expandedArray);
     }
-  }
+  };
 
   //rendering formattedData to UI based on typeahead
   const renderNestedOptions = (items: { [key: string]: any }[]) => {
@@ -248,9 +245,9 @@ const MultiLevelSelect = (props: MultiLevelSelectProps) => {
         {Array.isArray(items) &&
           items.map((item: { [key: string]: any }) => {
             return (
-              <div key={item.id}>
-                <li className='dropdown_item' data-name={item.id}>
-                  <div className='dropdown_item_checkbox_row'>
+              <>
+                <li key={item.id} className="dropdown_item" data-name={item.id}>
+                  <div className="dropdown_item_checkbox_row">
                     <div
                       key={isExpanded(item) ? "chevron-down" : "chevron-right"}
                     >
@@ -266,17 +263,17 @@ const MultiLevelSelect = (props: MultiLevelSelectProps) => {
                         onClick={(event: any) =>
                           handleToggleClick(item.id, event)
                         }
-                        variant='link'
+                        variant="link"
                       />
                     </div>
                     <Checkbox text={item.label} id={item.id}>
                       <input
                         checked={item.checked}
-                        type='checkbox'
+                        type="checkbox"
                         name={item.label}
                         value={item.label}
                         onChange={(e) => {
-                          handledropdownItemClick(e, !item.checked)
+                          handledropdownItemClick(e, !item.checked);
                         }}
                       />
                     </Checkbox>
@@ -288,30 +285,24 @@ const MultiLevelSelect = (props: MultiLevelSelectProps) => {
                       <div>{renderNestedOptions(item.children)}</div>
                     )}
                 </li>
-              </div>
-            )
+              </>
+            );
           })}
       </ul>
-    )
-  }
+    );
+  };
 
   return (
     <div {...ariaProps} {...dataProps} className={classes} id={id}>
-      <div ref={dropdownRef} className='wrapper'>
-        <div className='input_wrapper' onClick={handleInputWrapperClick}>
-          <div className='input_inner_container'>
-            {returnedArray.length !== 0 && returnAllSelected
-              ? returnedArray.map((item) => (
-                  <input type='hidden' name={`${name}[]`} value={item.id} />
-                ))
-              : null}
-
+      <div ref={dropdownRef} className="wrapper">
+        <div className="input_wrapper" onClick={handleInputWrapperClick}>
+          <div className="input_inner_container">
             {returnedArray.length !== 0 && returnAllSelected
               ? returnedArray.map((item, index) => (
                   <FormPill
                     key={index}
                     text={item.label}
-                    size='small'
+                    size="small"
                     onClick={(event: any) => handlePillClose(event, item)}
                   />
                 ))
@@ -322,29 +313,29 @@ const MultiLevelSelect = (props: MultiLevelSelectProps) => {
                 <FormPill
                   key={index}
                   text={item.label}
-                  size='small'
+                  size="small"
                   onClick={(event: any) => handlePillClose(event, item)}
                 />
               ))}
             {returnedArray.length !== 0 && returnAllSelected && <br />}
             {defaultReturn.length !== 0 && !returnAllSelected && <br />}
             <input
-              id='multiselect_input'
+              id="multiselect_input"
               onChange={(e) => {
-                setFilterItem(e.target.value)
+                setFilterItem(e.target.value);
               }}
-              placeholder='Start typing...'
+              placeholder="Start typing..."
               value={filterItem}
               onClick={() => setIsClosed(false)}
             />
           </div>
           {isClosed ? (
-            <div key='chevron-down'>
-              <Icon icon='chevron-down' />
+            <div key="chevron-down">
+              <Icon icon="chevron-down" />
             </div>
           ) : (
-            <div key='chevron-up'>
-              <Icon icon='chevron-up' />
+            <div key="chevron-up">
+              <Icon icon="chevron-up" />
             </div>
           )}
         </div>
@@ -355,7 +346,7 @@ const MultiLevelSelect = (props: MultiLevelSelectProps) => {
         </div>
       </div>
     </div>
-  )
-}
+  );
+};
 
-export default MultiLevelSelect
+export default MultiLevelSelect;

data/app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_default.html.erb

@@ -1,72 +1,72 @@
 <% treeData = [{
     label: "Power Home Remodeling",
     value: "Power Home Remodeling",
-    id: "100",
+    id: "powerhome1",
     expanded: true,
     children: [
       {
         label: "People",
         value: "People",
-        id: "101",
+        id: "people1",
         children: [
           {
             label: "Talent Acquisition",
             value: "Talent Acquisition",
-            id: "102",
+            id: "talent1",
           },
           {
             label: "Business Affairs",
             value: "Business Affairs",
-            id: "103",
+            id: "business1",
             children: [
               {
                 label: "Initiatives",
                 value: "Initiatives",
-                id: "104",
+                id: "initiative1",
               },
               {
                 label: "Learning & Development",
                 value: "Learning & Development",
-                id: "105",
+                id: "development1",
               },
             ],
           },
           {
             label: "People Experience",
             value: "People Experience",
-            id: "106",
+            id: "experience1",
           },
         ],
       },
       {
         label: "Contact Center",
         value: "Contact Center",
-        id: "107",
+        id: "contact1",
         children: [
           {
             label: "Appointment Management",
             value: "Appointment Management",
-            id: "108",
+            id: "appointment1",
           },
           {
             label: "Customer Service",
             value: "Customer Service",
-            id: "109",
+            id: "customer1",
           },
           {
             label: "Energy",
             value: "Energy",
-            id: "110",
+            id: "energy1",
           },
         ],
       },
     ],
-}] %>
+  }] %>
 
 
+<%= pb_rails("multi_level_select", props: {
+    id: "default-multi-level-select",
+    tree_data:treeData
+    }) %>
+
 
-  <%= pb_rails("multi_level_select", props: {
-      id: "multi-level-select-default-rails",
-      name: "my_array",
-      tree_data: treeData
-  }) %>

data/app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_default.jsx

@@ -72,18 +72,15 @@ const MultiLevelSelectDefault = (props) => {
   return (
     <div>
       <MultiLevelSelect
-          id='multiselect-default'
+          id="multiselect-default"
           onSelect={(selectedNodes) =>
-          console.log(
-            "Selected Items",
-            selectedNodes
-          )
-        }
+          console.log("Selected Items", selectedNodes)
+          }
           treeData={treeData}
           {...props}
       />
     </div>
-  )
+  );
 };
 
 export default MultiLevelSelectDefault;

data/app/pb_kits/playbook/pb_multi_level_select/docs/_multi_level_select_default.md

@@ -1,5 +1,5 @@
 The MultiLevelSelect kit renders a multi leveled select dropdown based on data from the user. `treeData` is a required prop that is expected to contain the data in the form of an array of objects. See code snippet for an example data array.
 
-For the React version of the kit, the `onSelect` prop returns an array of objects. This array contains all checked items irrespective of whether it is a parent, child or grandchild. Open the console on this example and check and uncheck checkboxes to see this is action! 
+For the React version of the kit, the `onSelect` prop returns an array of all checked items, irrespective of whether it is a parent, child or grandchild. Open the console on this example and check and uncheck checkboxes to see this is action!
 
-For the Rails version of the kit, there is no onselect. The form submits as a array of strings, following the typical rails pattern of utilizing hidden inputs. The strings are the values of the selected items' ids. For example, ["103", "106", "107"].
+For the Rails version, the array of checked items is attached to the DOM in a data attribute titled `data-tree` on the wrapping div around  the MultiLevelSelect.