playbook_ui 13.24.0 → 13.25.0.pre.alpha.PBNTR272Dropdownkitv42769

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

@@ -0,0 +1,266 @@
+import React, { useState, useRef, useEffect, ReactElement } from "react";
+import classnames from "classnames";
+import { buildAriaProps, buildCss, buildDataProps, buildHtmlProps } from "../utilities/props";
+import { globalProps } from "../utilities/globalProps";
+
+import Body from "../pb_body/_body";
+import Caption from "../pb_caption/_caption";
+
+import DropdownContainer from "./subcomponents/DropdownContainer";
+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";
+
+type DropdownProps = {
+  aria?: { [key: string]: string };
+  autocomplete?: boolean;
+  children?: React.ReactChild[] | React.ReactChild | ReactElement[];
+  className?: string;
+  dark?: boolean;
+  data?: { [key: string]: string };
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
+  id?: string;
+  isClosed?: boolean;
+  label?: string;
+  onSelect?: (arg: GenericObject) => null;
+  options: GenericObject;
+  triggerRef?: any;
+};
+
+const Dropdown = (props: DropdownProps) => {
+  const {
+    aria = {},
+    autocomplete = false,
+    children,
+    className,
+    dark = false,
+    data = {},
+    htmlOptions = {},
+    id,
+    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(isClosed);
+
+  const [filterItem, setFilterItem] = 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(() => {
+    // 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';
+      }
+  }
+  // Handle clicks outside the dropdown
+    const handleClickOutside = (e: MouseEvent) => {
+      let targetElement = e.target as HTMLElement;
+      let shouldClose = true;
+  
+      while (targetElement && shouldClose) {
+        //Only needed for when useDropdown hook used with external trigger
+        if (targetElement.getAttribute('data-dropdown') === 'pb-dropdown-trigger') {
+          shouldClose = false;
+        }
+        targetElement = targetElement.parentElement as HTMLElement;
+      }
+      if (
+        inputWrapperRef.current && !inputWrapperRef.current.contains(e.target) &&
+        (dropdownContainerRef.current && !dropdownContainerRef.current.contains(e.target)) &&
+        shouldClose
+      ) {
+        setIsDropDownClosed(true);
+        setFocusedOptionIndex(-1);
+        setIsInputFocused(false);
+      }
+    };
+  
+    window.addEventListener("click", handleClickOutside);
+    return () => {
+      window.removeEventListener("click", handleClickOutside);
+    };
+  }, []);
+
+  useEffect(() => {
+    setHasTriggerSubcomponent(!!trigger);
+    setHasContainerSubcomponent(!!container);
+  }, []);
+
+// dropdown to toggle with external control
+  useEffect(()=> {
+    setIsDropDownClosed(isClosed)
+   },[isClosed])
+
+  const filteredOptions = options?.filter((option: GenericObject) =>
+    option.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);
+  };
+
+  const handleOptionClick = (selectedItem: GenericObject) => {
+    setSelected(selectedItem);
+    setFilterItem("");
+    setIsDropDownClosed(true);
+    onSelect && onSelect(selectedItem);
+  };
+
+  const handleWrapperClick = () => {
+    autocomplete && inputRef.current.focus();
+    toggleDropdown();
+  };
+
+  const handleBackspace = () => {
+    setSelected({});
+    onSelect && onSelect(null);
+    setFocusedOptionIndex(-1);
+  };
+
+  const componentsToRender = prepareSubcomponents({
+    children,
+    hasTriggerSubcomponent,
+    hasContainerSubcomponent,
+    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,
+              handleBackspace,
+              handleChange,
+              handleOptionClick,
+              handleWrapperClick,
+              inputRef,
+              inputWrapperRef,
+              isDropDownClosed,
+              isInputFocused,
+              options,
+              selected,
+              setFocusedOptionIndex,
+              setIsDropDownClosed,
+              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 ? (
+            <>
+              {componentsToRender.map((component, index) => (
+                <React.Fragment key={index}>{component}</React.Fragment>
+              ))}
+            </>
+          ) : (
+            <>
+              <DropdownTrigger />
+              <DropdownContainer>
+                {options &&
+                  options?.map((option: GenericObject) => (
+                    <Dropdown.Option key={option.id} 
+                        option={option}
+                    >
+                      <Body text={option.label} />
+                    </Dropdown.Option>
+                  ))}
+              </DropdownContainer>
+            </>
+          )}
+        </div>
+      </DropdownContext.Provider>
+    </div>
+  )
+};
+
+Dropdown.Option = DropdownOption;
+Dropdown.Trigger = DropdownTrigger;
+Dropdown.Container = DropdownContainer;
+
+export default Dropdown;

data/app/pb_kits/playbook/pb_dropdown/context/index.tsx

@@ -0,0 +1,5 @@
+import { createContext } from "react";
+
+const DropdownContext = createContext<any>({});
+
+export default DropdownContext;

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

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

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

@@ -0,0 +1 @@
+`options` for the Dropdown and `option` for the Dropdown.Option are the only required props for this kit. `options` must be an array of objects. Each object can contain any key/value pairs needed but 'label' and 'value' are required.

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

@@ -0,0 +1,87 @@
+import React, { useState } from 'react'
+import { Dropdown, User, Badge, FlexItem } from '../..'
+
+const DropdownWithAutocomplete = (props) => {
+// eslint-disable-next-line no-unused-vars
+  const [selectedOption, setSelectedOption] = useState();
+
+  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 Desinger",
+      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
+        onSelect={(selectedItem) => setSelectedOption(selectedItem)}
+        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. 

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

@@ -0,0 +1,102 @@
+import React, { useState } from 'react'
+import { Dropdown, User, Badge, FlexItem, Avatar } from '../..'
+
+const DropdownWithAutocompleteAndCustomDisplay = (props) => {
+// eslint-disable-next-line no-unused-vars
+  const [selectedOption, setSelectedOption] = useState();
+
+  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 Desinger",
+      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"
+    }
+  ];
+
+  const CustomDisplay = () => {
+    return (
+      <>
+      {
+        selectedOption && (
+            <Avatar
+                name={selectedOption.label}
+                size="xs"
+            />
+        )
+      }
+    </>
+    )
+  };
+
+  return (
+  <div>
+    <Dropdown autocomplete
+        onSelect={(selectedItem) => setSelectedOption(selectedItem)}
+        options={options}
+        {...props}
+    >
+        <Dropdown.Trigger customDisplay={<CustomDisplay/>} />
+        {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  DropdownWithAutocompleteAndCustomDisplay

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

@@ -0,0 +1 @@
+`autocomplete` prop can also be used in conjunction with the `customDisplay` prop.

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

@@ -0,0 +1,104 @@
+import React, { useState } from 'react'
+import { Dropdown, User, FlexItem, Badge, Avatar } from '../../'
+
+const DropdownWithCustomDisplay = (props) => {
+  const [selectedOption, setSelectedOption] = useState();
+
+  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 Desinger",
+      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"
+    }
+  ];
+
+  const CustomDisplay = () => {
+    return (
+      <>
+      {
+        selectedOption && (
+            <Avatar
+                name={selectedOption.label}
+                size="xs"
+            />
+        )
+      }
+    </>
+    )
+  };
+
+
+  return (
+  <div>
+    <Dropdown
+        onSelect={(selectedItem) => setSelectedOption(selectedItem)}
+        options={options}
+        {...props}
+    >
+      <Dropdown.Trigger customDisplay={<CustomDisplay/>}
+          placeholder="Select a User"
+      />
+        {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 dark
+                    rounded
+                    text={option.status}
+                    variant={`${
+                        option.status === "Offline"
+                        ? "neutral"
+                        : option.status === "Online"
+                        ? "success"
+                        : "warning"
+                    }`}
+                />
+              </FlexItem>
+            </>
+          </Dropdown.Option>
+        ))}
+    </Dropdown>
+  </div>
+  )
+}
+
+export default DropdownWithCustomDisplay

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

@@ -0,0 +1,5 @@
+The `customDisplay` prop can be used to customize the display of the selected item by allowing devs to pass in a component that will be rendered to the left of the default text-based display. In this example the Avatar kit is being used.
+
+The `placeholder` prop can also be used to customize the placeholder text for the default Trigger. 
+
+The `onSelect` prop is a function that gives the dev one argument: the selected option. In this example we are using the    `onSelect` to set a state with the selected option and using it to customize the `customDisplay`.

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

@@ -0,0 +1,63 @@
+import React from 'react'
+import { Dropdown, Icon, Body, FlexItem, Flex } from '../..'
+
+const DropdownWithCustomOptions = (props) => {
+
+  const options = [
+    {
+      label: "United States",
+      value: "United States",
+      areaCode: "+1",
+      icon: "🇺🇸",
+      id: "United-states"
+    },
+    {
+      label: "Canada",
+      value: "Canada",
+      areaCode: "+1",
+      icon: "🇨🇦",
+      id: "canada"
+    },
+    {
+      label: "Pakistan",
+      value: "Pakistan",
+      areaCode: "+92",
+      icon: "🇵🇰",
+      id: "pakistan"
+    }
+  ];  
+
+
+  return (
+  <div>
+    <Dropdown
+        options={options}
+        {...props}
+    >
+        {options.map((option) => (
+          <Dropdown.Option key={option.id} 
+              option={option}
+          >
+            <>
+              <FlexItem>
+                <Flex>
+                  <Icon icon={option.icon} 
+                      paddingRight="xs"
+                  />
+                  <Body text={option.label} />
+                </Flex>
+              </FlexItem>
+              <FlexItem>
+                <Body color="light" 
+                    text={option.areaCode} 
+                />
+              </FlexItem>
+            </>
+          </Dropdown.Option>
+        ))}
+    </Dropdown>
+  </div>
+  )
+}
+
+export default  DropdownWithCustomOptions

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

@@ -0,0 +1 @@
+The Dropdown also allows for custom options that can be passed in as children to the `Dropdown.Option` subcomponent. If no children are passed in the `Dropdown.Option`, the kit will render each option as text by default.