playbook_ui 12.26.1.pre.alpha.play716popoverkitcloseonclickissue833 → 12.26.1.pre.alpha.railsmultilevelimprovements837

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 { 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 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 {
   getAncestorsOfUnchecked,
@@ -15,17 +15,19 @@ import {
   getCheckedItems,
   getDefaultCheckedItems,
   recursiveCheckParent,
-} from "./_helper_functions";
+} from "./_helper_functions"
 
 type MultiLevelSelectProps = {
-  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;
+  aria?: { [key: string]: string }
+  className?: string
+  data?: { [key: string]: string }
+  id?: string
+  name?: string
+  returnCompleteData?: boolean
+  returnAllSelected?: boolean
+  treeData?: { [key: string]: string }[]
+  onSelect?: (prop: { [key: string]: any }) => void
+} & GlobalProps
 
 const MultiLevelSelect = (props: MultiLevelSelectProps) => {
   const {
@@ -33,71 +35,106 @@ const MultiLevelSelect = (props: MultiLevelSelectProps) => {
     className,
     data = {},
     id,
+    name,
     returnAllSelected = false,
+    returnCompleteData = 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([])
+
+  const [formattedReturn, setFormattedReturn] = useState([])
+
+  const getSelectedIds = (selectedData: { [key: string]: any }[]) => {
+    return selectedData.map((item) => item.id)
+  }
+
+  const getValues = () => {
+    if (returnCompleteData) {
+      if (returnAllSelected) {
+        return setFormattedReturn(returnedArray)
+      } else {
+        return setFormattedReturn(defaultReturn)
+      }
+    } else {
+      if (returnAllSelected) {
+        setFormattedReturn(getSelectedIds(returnedArray))
+      } else {
+        setFormattedReturn(getSelectedIds(defaultReturn))
+      }
+    }
+  }
+
 
   useEffect(() => {
-    setFormattedData(addCheckedAndParentProperty(treeData));
-  }, [treeData]);
+    getValues()
+  }, [returnedArray, defaultReturn])
+
+  useEffect(() => {
+    onSelect(formattedReturn)
+  }, [formattedReturn])
+
+  useEffect(() => {
+    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 = (
@@ -106,48 +143,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 = (
@@ -156,87 +193,86 @@ 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);
-    console.log(updatedTree);
+    const filtered = filterFormattedDataById(formattedData, clickedItem)
+    const updatedTree = changeItem(filtered[0], check)
     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 }[]) => {
@@ -246,8 +282,8 @@ const MultiLevelSelect = (props: MultiLevelSelectProps) => {
           items.map((item: { [key: string]: any }) => {
             return (
               <>
-                <li key={item.id} 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"}
                     >
@@ -263,17 +299,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>
@@ -286,23 +322,27 @@ const MultiLevelSelect = (props: MultiLevelSelectProps) => {
                     )}
                 </li>
               </>
-            );
+            )
           })}
       </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">
+      <div ref={dropdownRef} className='wrapper'>
+        <div className='input_wrapper' onClick={handleInputWrapperClick}>
+          <div className='input_inner_container'>
+            {returnedArray.map((item) => (
+              <input type='hidden' name={`${name}[]`} value={item.id} />
+            ))}
+
             {returnedArray.length !== 0 && returnAllSelected
               ? returnedArray.map((item, index) => (
                   <FormPill
                     key={index}
                     text={item.label}
-                    size="small"
+                    size='small'
                     onClick={(event: any) => handlePillClose(event, item)}
                   />
                 ))
@@ -313,29 +353,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>
@@ -346,7 +386,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

@@ -61,12 +61,18 @@
         ],
       },
     ],
-  }] %>
+}] %>
 
 
-<%= pb_rails("multi_level_select", props: {
-    id: "default-multi-level-select",
-    tree_data:treeData
-    }) %>
-
 
+<%= pb_form_with(scope: :example, url: "", method: :get) do |form| %>
+  <%= pb_rails("multi_level_select", props: {
+      id: "default-multi-level-select-test",
+      name: "my_array",
+      tree_data: treeData
+  }) %>
+  <%= form.actions do |action| %>
+    <%= action.submit %>
+    <%= action.button props: { type: "reset", text: "Cancel", variant: "secondary" } %>
+  <% end %>
+<% end %>

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

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

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

@@ -2,4 +2,4 @@ The MultiLevelSelect kit renders a multi leveled select dropdown based on data f
 
 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, the array of checked items is attached to the DOM in a data attribute titled `data-tree` on the wrapping div around  the MultiLevelSelect.
+By default, the return will be an array of Id's. If you want to return the entire object, you can pass `returnCompleteData` as true. This will return an array of objects. 

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

@@ -3,7 +3,6 @@
     value: "Power Home Remodeling",
     id: "powerhome1",
     expanded: true,
-
     children: [
       {
         label: "People",
@@ -62,11 +61,19 @@
         ],
       },
     ],
-  }] %>
+}] %>
+
 
 
-<%= pb_rails("multi_level_select", props: {
-    id: "parent-persistence-multi-level-select",
-    tree_data:treeData,
-    return_all_selected: true
-    }) %>
+<%= pb_form_with(scope: :example, url: "", method: :get) do |form| %>
+  <%= pb_rails("multi_level_select", props: {
+      id: "default-multi-level-select-test-return-all-selected",
+      name: "q[user_title_org_level_id_in]",
+      tree_data: treeData,
+      return_all_selected: true
+  }) %>
+  <%= form.actions do |action| %>
+    <%= action.submit %>
+    <%= action.button props: { type: "reset", text: "Cancel", variant: "secondary" } %>
+  <% end %>
+<% end %>

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

@@ -74,7 +74,7 @@ const MultiLevelSelectReturnAllSelected = (props) => {
       <MultiLevelSelect
           id="multiselect-parent-persistence"
           onSelect={(selectedNodes) =>
-          console.log("Selected Items", selectedNodes)
+          console.log("Selected Items with Return All Selected Data", selectedNodes)
           }
           returnAllSelected
           treeData={treeData}

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

@@ -0,0 +1,73 @@
+<% treeData = [{
+    label: "Power Home Remodeling",
+    value: "Power Home Remodeling",
+    id: "powerhome1",
+    expanded: true,
+    children: [
+      {
+        label: "People",
+        value: "People",
+        id: "people1",
+        children: [
+          {
+            label: "Talent Acquisition",
+            value: "Talent Acquisition",
+            id: "talent1",
+          },
+          {
+            label: "Business Affairs",
+            value: "Business Affairs",
+            id: "business1",
+            children: [
+              {
+                label: "Initiatives",
+                value: "Initiatives",
+                id: "initiative1",
+              },
+              {
+                label: "Learning & Development",
+                value: "Learning & Development",
+                id: "development1",
+              },
+            ],
+          },
+          {
+            label: "People Experience",
+            value: "People Experience",
+            id: "experience1",
+          },
+        ],
+      },
+      {
+        label: "Contact Center",
+        value: "Contact Center",
+        id: "contact1",
+        children: [
+          {
+            label: "Appointment Management",
+            value: "Appointment Management",
+            id: "appointment1",
+          },
+          {
+            label: "Customer Service",
+            value: "Customer Service",
+            id: "customer1",
+          },
+          {
+            label: "Energy",
+            value: "Energy",
+            id: "energy1",
+          },
+        ],
+      },
+    ],
+  }] %>
+
+
+<%= pb_rails("multi_level_select", props: {
+    id: "default-multi-level-select",
+    tree_data: treeData, 
+    return_complete_data: true
+}) %>
+
+