snapshot of https://github.com/makeplane/plane.git @ d868349a55de79979eb8b98701bf1702c67ad634 (2026-09-15)

apps/web/core/hooks/use-dropdown.ts

@@ -0,0 +1,87 @@
+/**
+ * Copyright (c) 2023-present Plane Software, Inc. and contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * See the LICENSE file for details.
+ */
+
+import { useEffect } from "react";
+// plane helpers
+import { useOutsideClickDetector } from "@plane/hooks";
+// hooks
+import { useDropdownKeyDown } from "@/hooks/use-dropdown-key-down";
+import { usePlatformOS } from "./use-platform-os";
+
+type TArguments = {
+  dropdownRef: React.RefObject<HTMLDivElement | null>;
+  inputRef?: React.RefObject<HTMLInputElement | null>;
+  isOpen: boolean;
+  onClose?: () => void;
+  onOpen?: () => Promise<void> | void;
+  query?: string;
+  setIsOpen: React.Dispatch<React.SetStateAction<boolean>>;
+  setQuery?: React.Dispatch<React.SetStateAction<string>>;
+};
+
+export const useDropdown = (args: TArguments) => {
+  const { dropdownRef, inputRef, isOpen, onClose, onOpen, query, setIsOpen, setQuery } = args;
+
+  const { isMobile } = usePlatformOS();
+
+  /**
+   * @description clear the search input when the user presses the escape key, if the search input is not empty
+   * @param {React.KeyboardEvent<HTMLInputElement>} e
+   */
+  const searchInputKeyDown = (e: React.KeyboardEvent<HTMLInputElement>) => {
+    if (query !== "" && e.key === "Escape") {
+      e.stopPropagation();
+      setQuery?.("");
+    }
+  };
+
+  /**
+   * @description close the dropdown, clear the search input, and call the onClose callback
+   */
+  const handleClose = () => {
+    if (!isOpen) return;
+    setIsOpen(false);
+    onClose?.();
+    setQuery?.("");
+  };
+
+  // toggle the dropdown, call the onOpen callback if the dropdown is closed, and call the onClose callback if the dropdown is open
+  const toggleDropdown = () => {
+    if (!isOpen) onOpen?.();
+    setIsOpen((prevIsOpen) => !prevIsOpen);
+    if (isOpen) onClose?.();
+  };
+
+  const handleKeyDown = useDropdownKeyDown(toggleDropdown, handleClose);
+
+  /**
+   * @description toggle the dropdown on click
+   * @param {React.MouseEvent<HTMLButtonElement, MouseEvent>} e
+   */
+  const handleOnClick = (e: React.MouseEvent<HTMLButtonElement, MouseEvent>) => {
+    e.stopPropagation();
+    e.preventDefault();
+    toggleDropdown();
+  };
+
+  // close the dropdown when the user clicks outside of the dropdown
+  // skip binding the document listener entirely while the dropdown is closed
+  useOutsideClickDetector(dropdownRef, handleClose, false, isOpen);
+
+  // focus the search input when the dropdown is open
+  useEffect(() => {
+    if (isOpen && inputRef?.current && !isMobile) {
+      inputRef.current.focus();
+    }
+  }, [inputRef, isOpen, isMobile]);
+
+  return {
+    handleClose,
+    handleKeyDown,
+    handleOnClick,
+    searchInputKeyDown,
+  };
+};