All files / src/components tree-select.tsx

35.29% Statements 12/34
20.68% Branches 6/29
21.42% Functions 3/14
37.5% Lines 12/32

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187                                                                                                              8x                     4x   4x   4x 2x       4x   4x 2x     4x                   4x                                             4x                                                                                     4x                                                          
import {
  type ReactNode,
  useCallback,
  useState,
  useEffect,
  useMemo,
} from 'react';
import cn from 'classnames';
import type { Except } from 'type-fest';
 
import DropdownButton, { type DropdownButtonProps } from './dropdown-button';
import Button from './button';
import Autocomplete from './autocomplete';
 
import {
  type BasicItem,
  getNodePaths,
  prepareTreeDataForAutocomplete,
  getSingleChildren,
} from '../utils';
 
import type { AutocompleteItemType } from './autocomplete-item';
 
import '../styles/components/tree-select.scss';
 
export type TreeSelectProps<Item extends BasicItem<Item>> = {
  /**
   * The tree structure
   */
  data: Item[];
  /**
   * What happens when something is selected
   */
  onSelect: (item: Omit<Item, 'items'>) => void;
  /**
   * Contains autocomplete functionality to search through tree
   */
  autocomplete?: boolean;
  /**
   * Placeholder for the autocomplete input box
   */
  autocompletePlaceholder?: string;
  autocompleteFilter?: boolean;
  /**
   * The displayed label on the button
   */
  label?: ReactNode;
  /**
   * Array of default active nodes for initialisation
   */
  defaultActiveNodes?: Item['id'][];
};
 
type SetShowDropdownMenu = (show: boolean) => void;
 
const TreeSelect = <Item extends BasicItem<Item>>({
  data,
  onSelect,
  autocomplete = false,
  autocompletePlaceholder = '',
  autocompleteFilter = true,
  defaultActiveNodes = [],
  label,
  ...props
}: Except<DropdownButtonProps, 'children' | 'label' | 'onSelect'> &
  TreeSelectProps<Item>) => {
  const [activeNodes, setActiveNodes] = useState(defaultActiveNodes);
 
  const [openNodes, setOpenNodes] = useState<BasicItem<Item>['id'][]>([]);
  // When data changes, we need to update which nodes need to be open
  useEffect(() => {
    setOpenNodes(Array.from(getSingleChildren(data)));
  }, [data]);
 
  const [autocompleteShowDropdown, setAutocompleteShowDropdown] =
    useState(false);
 
  const autocompleteData = useMemo(
    () => prepareTreeDataForAutocomplete(getNodePaths(data)),
    [data]
  );
  const toggleNode = useCallback(
    (node: AutocompleteItemType | BasicItem<Item>) =>
      setOpenNodes((openNodes) =>
        openNodes.includes(node.id)
          ? openNodes.filter((id) => id !== node.id)
          : [...openNodes, node.id]
      ),
    []
  );
 
  const handleNodeClick = useCallback(
    (
      node: AutocompleteItemType | BasicItem<Item> | string,
      setShowDropdownMenu: SetShowDropdownMenu
    ) => {
      // Don't register when user hasn't specifically selected something
      if (typeof node === 'string') {
        return;
      }
      if (node.items) {
        toggleNode(node);
      } else {
        const path = getNodePaths(data, node.id)[0];
        const leafNode = path[path.length - 1];
        setActiveNodes(path.map((d) => d.id));
        setOpenNodes(path.map((d) => d.id));
        onSelect(leafNode);
        setShowDropdownMenu(false);
      }
    },
    [data, onSelect, toggleNode]
  );
 
  const buildTree = useCallback(
    (
      items: BasicItem<Item>[],
      setShowDropdownMenu: SetShowDropdownMenu,
      first = false
    ) => (
      <ul role={first ? 'tree' : 'group'}>
        {items.map((node) => {
          let ariaExpanded: undefined | 'true' | 'false';
          if (node.items) {
            ariaExpanded = openNodes.includes(node.id) ? 'true' : 'false';
          }
          return (
            <li
              key={node.id}
              role="treeitem"
              aria-expanded={ariaExpanded}
              aria-selected={ariaExpanded}
              className={cn({ branch: node.items })}
            >
              <Button
                onClick={() => handleNodeClick(node, setShowDropdownMenu)}
                className={cn({ active: activeNodes.includes(node.id) })}
                variant="secondary"
                aria-label={
                  node.items?.length
                    ? `${node.label} (${node.items.length} nested option${
                        node.items.length === 1 ? '' : 's'
                      })`
                    : undefined
                }
              >
                {node.label}
              </Button>
              {node.items && buildTree(node.items, setShowDropdownMenu)}
            </li>
          );
        })}
      </ul>
    ),
    [activeNodes, handleNodeClick, openNodes]
  );
 
  return (
    <DropdownButton label={label || 'Select'} {...props}>
      {(setShowDropdownMenu: SetShowDropdownMenu) => (
        <>
          {autocomplete && (
            <Autocomplete
              data={autocompleteData}
              onDropdownChange={setAutocompleteShowDropdown}
              onSelect={(node: AutocompleteItemType | string) =>
                handleNodeClick(node, setShowDropdownMenu)
              }
              placeholder={autocompletePlaceholder}
              filter={autocompleteFilter}
              clearOnSelect
              autoFocus
            />
          )}
          {!autocompleteShowDropdown && (
            <div className="dropdown-menu__panel">
              {buildTree(data, setShowDropdownMenu, true)}
            </div>
          )}
        </>
      )}
    </DropdownButton>
  );
};
 
export default TreeSelect;