From b1eec4b9c816a2ddaa4a18fb65277450f6354bd1 Mon Sep 17 00:00:00 2001
From: RAGHAV <94848646+raghav1030@users.noreply.github.com>
Date: Wed, 11 Oct 2023 12:39:34 +0530
Subject: [PATCH] fix: fixed the behavior of dropdown list when clicked outside
 of its scope (#1838)

* Fixed the behavior of dropdownlist when clicked outside of its scope.

* removed unwanted console.log

* Fixed a bug

* removed unnecessary console.log()

* Restricted topbar icons to inherit click-outside functionality

---------

Co-authored-by: Rupali Haldiya <78981177+rupali-codes@users.noreply.github.com>
---
 components/Backdrop/Backdrop.tsx              |  1 +
 components/Cards/Card.tsx                     |  6 ++--
 components/Header/Header.tsx                  |  4 +--
 components/SideNavbar/SideNavbarCategory.tsx  | 15 +++++++--
 .../SideNavbar/SideNavbarCategoryList.tsx     |  8 +++--
 components/popup/popupInfo.tsx                |  1 +
 hooks/useOnClickOutside.ts                    | 32 +++++++++++++++++++
 pages/[category]/index.tsx                    | 14 +++++---
 8 files changed, 68 insertions(+), 13 deletions(-)
 create mode 100644 hooks/useOnClickOutside.ts

diff --git a/components/Backdrop/Backdrop.tsx b/components/Backdrop/Backdrop.tsx
index 84115a88c..8a58ba65a 100644
--- a/components/Backdrop/Backdrop.tsx
+++ b/components/Backdrop/Backdrop.tsx
@@ -24,6 +24,7 @@ export const Backdrop: FC<{
 
   return createPortal(
     <div
+    data-custom='restrict-click-outside'
       className={`fixed inset-0 z-50 h-full w-full cursor-pointer bg-black/80
          ${className}
          ${status === 'preEnter' || status === 'entering' ? '' : 'opacity-0'}
diff --git a/components/Cards/Card.tsx b/components/Cards/Card.tsx
index 365dc4688..a8628159e 100644
--- a/components/Cards/Card.tsx
+++ b/components/Cards/Card.tsx
@@ -23,7 +23,7 @@ export const Card: FC<CardProps> = ({ data }) => {
   }, [])
 
   return (
-    <article className="z-10 h-full w-full rounded-3xl border border-dashed border-theme-secondary dark:border-theme-primary bg-[rgba(255,255,255,0.3)] shadow-md dark:bg-dark dark:text-text-primary dark:shadow-sm">
+    <article data-custom='restrict-click-outside' className="z-10 h-full w-full rounded-3xl border border-dashed border-theme-secondary dark:border-theme-primary bg-[rgba(255,255,255,0.3)] shadow-md dark:bg-dark dark:text-text-primary dark:shadow-sm">
       <div className="card-body">
         <header className="flex justify-between items-center gap-2">
           <h2
@@ -32,7 +32,9 @@ export const Card: FC<CardProps> = ({ data }) => {
           >
             {name}
           </h2>
-          <div className="flex items-center gap-1">
+          <div
+            className="flex items-center gap-1"
+          >
             <CopyToClipboard url={url} />
             <Share url={`${url}?ref=LinksHub`} title={name} />
           </div>
diff --git a/components/Header/Header.tsx b/components/Header/Header.tsx
index cdae6366c..609028add 100644
--- a/components/Header/Header.tsx
+++ b/components/Header/Header.tsx
@@ -19,12 +19,12 @@ export const Header: FC = () => {
           <Logo className="text-3xl" />
         </Link>
       </div>
-      <div className="bg-light-primary relative h-full grow px-8 dark:bg-dark lg:dark:bg-dark-primary">
+      <div data-custom='restrict-click-outside' className="bg-light-primary relative h-full grow px-8 dark:bg-dark lg:dark:bg-dark-primary">
         <TopBar
           className="absolute left-8 hidden h-full md:flex"
           results={results}
         />
-        <div className="absolute right-8 flex h-full gap-4">
+        <div data-custom='restrict-click-outside' className="absolute right-8 flex h-full gap-4">
           <SocialMediaIconsList className="hidden lg:flex" />
           <ThemeToggler />
           <button
diff --git a/components/SideNavbar/SideNavbarCategory.tsx b/components/SideNavbar/SideNavbarCategory.tsx
index 2b51d0d9d..3eb28897a 100644
--- a/components/SideNavbar/SideNavbarCategory.tsx
+++ b/components/SideNavbar/SideNavbarCategory.tsx
@@ -3,14 +3,18 @@ import { FaAngleDown } from 'react-icons/fa'
 import { SideNavbarElement } from './SideNavbarElement'
 import type { ISidebar } from '../../types'
 import Link from 'next/link'
+import useOnClickOutside from 'hooks/useOnClickOutside'
+import { useRouter } from 'next/router'
+
 
 export const SideNavbarCategory: FC<{
   categoryData: ISidebar
   expand: boolean
-}> = ({ categoryData, expand }) => {
+  listRef: React.MutableRefObject<HTMLUListElement | null>
+}> = ({ categoryData, expand, listRef }) => {
   const [isOpen, setIsOpen] = useState(expand)
-
   const { category, subcategory } = categoryData
+  const router = useRouter();
   const sortedSubcategoryList = subcategory
     .sort((a, b) => (a.name.toUpperCase() < b.name.toUpperCase() ? -1 : 1))
     .map((subcategoryData, i) => (
@@ -27,11 +31,16 @@ export const SideNavbarCategory: FC<{
     setIsOpen(!isOpen)
   }
 
+  useOnClickOutside(listRef, () =>{
+    setIsOpen(false)
+    router.push('/')
+  })
+
   return (
     <li className="relative w-full transition-all ease-in-out text-theme-secondary dark:text-theme-primary dark:bg-opacity-5 hover:text-theme-secondary dark:hover:text-theme-primary rounded-md focus-visible:outline-none focus-visible:ring focus-visible:ring-theme-primary">
       <Link
         className="flex w-full cursor-pointer justify-between py-2"
-        onClick={handleToggle}
+        onClick={() => handleToggle()}
         aria-label="toggle category"
         href={`/${category}`}
       >
diff --git a/components/SideNavbar/SideNavbarCategoryList.tsx b/components/SideNavbar/SideNavbarCategoryList.tsx
index c9ffc1834..9487e3d18 100644
--- a/components/SideNavbar/SideNavbarCategoryList.tsx
+++ b/components/SideNavbar/SideNavbarCategoryList.tsx
@@ -1,4 +1,4 @@
-import React, { FC, useEffect, useState } from 'react'
+import React, { FC, useEffect, useState, useRef } from 'react'
 import type { SubCategories } from '../../types'
 import { sidebarData } from 'database/data'
 import { SideNavbarCategory } from './SideNavbarCategory'
@@ -10,6 +10,7 @@ export const SideNavbarCategoryList: FC<{
   const categoriesList = getFilteredCategoryList(query)
   const router = useRouter()
   const [category, setCategory] = useState<string | undefined>('')
+  const listRef = useRef<HTMLUListElement | null>(null)
 
   useEffect(() => {
     const cat: string | undefined = router.query.category as string | undefined
@@ -28,10 +29,13 @@ export const SideNavbarCategoryList: FC<{
   }
 
   return (
-    <ul className="mt-2 flex flex-col justify-center px-4 pb-24">
+    <ul ref={listRef} className="mt-2 flex flex-col justify-center px-4 pb-24">
+      {/* Reset the open/close states of categories. This makes sure that
+      changes to the toggle state don't reflect when a new query is submitted */}
       <React.Fragment key={query}>
         {categoriesList.map((categoryData) => (
           <SideNavbarCategory
+            listRef={listRef}
             key={categoryData.category}
             categoryData={categoryData}
             expand={query.length > 0 || category === categoryData.category}
diff --git a/components/popup/popupInfo.tsx b/components/popup/popupInfo.tsx
index 814eb7fb1..a8443908c 100644
--- a/components/popup/popupInfo.tsx
+++ b/components/popup/popupInfo.tsx
@@ -27,6 +27,7 @@ export const PopupInfo: React.FC<{
       <Backdrop onClick={onClose} />
       {createPortal(
         <div
+          data-custom="restrict-click-outside"
           onClick={(e) => e.stopPropagation()}
           className={`fixed left-1/2 top-1/2 z-[150] max-w-[500px] -translate-x-1/2 -translate-y-1/2 transition-all ${
             currentCard ? 'animate-scale-appearance' : 'animate-scale-hide'
diff --git a/hooks/useOnClickOutside.ts b/hooks/useOnClickOutside.ts
new file mode 100644
index 000000000..63e123edd
--- /dev/null
+++ b/hooks/useOnClickOutside.ts
@@ -0,0 +1,32 @@
+import { MutableRefObject, useEffect } from 'react'
+
+const useOnClickOutside = (
+  ref: MutableRefObject<HTMLUListElement | null>,
+  handler: () => void
+) => {
+  useEffect(() => {
+    const handleClickOutside = (event: MouseEvent) => {
+      if (
+        event.target &&
+        (event.target as HTMLElement)?.closest('[data-custom="restrict-click-outside"]') !== null) {
+        return
+      }
+
+      if (
+        ref.current &&
+        !ref.current.classList.contains('copy-to-clipboard-button') &&
+        !ref.current.contains(event.target as Node)
+      ) {
+        handler()
+      }
+    }
+
+    document.addEventListener('mousedown', handleClickOutside)
+
+    return () => {
+      document.removeEventListener('mousedown', handleClickOutside)
+    }
+  }, [ref, handler])
+}
+
+export default useOnClickOutside
diff --git a/pages/[category]/index.tsx b/pages/[category]/index.tsx
index 655ab463b..76b48de6e 100644
--- a/pages/[category]/index.tsx
+++ b/pages/[category]/index.tsx
@@ -6,7 +6,7 @@ import Link from 'next/link'
 
 const CategoryPage = () => {
   const router = useRouter()
-  const { category } = router.query as { category: string}
+  const { category } = router.query as { category: string }
 
   const subcategories: SubCategories[] = []
   sidebarData.forEach((c) => {
@@ -34,7 +34,10 @@ const CategoryPage = () => {
                 resources!
               </p>
             </div>
-            <div className="flex flex-wrap gap-3 mt-6 justify-center items-start mx-auto lg:max-w-sm max-md:max-w-sm">
+            <div
+              data-custom="restrict-click-outside"
+              className="flex flex-wrap gap-3 mt-6 justify-center items-start mx-auto lg:max-w-sm max-md:max-w-sm"
+            >
               {subcategories.map((subcat, i) => (
                 <Link
                   key={i}
@@ -47,9 +50,12 @@ const CategoryPage = () => {
             </div>
           </>
         ) : (
-          <div className='text-center'>
+          <div className="text-center">
             <p className="text-theme-secondary dark:text-gray-text w-fit mx-auto text-center">
-              <span className='md:text-7xl text-xl uppercase font-bold '>404|</span> No resources found.
+              <span className="md:text-7xl text-xl uppercase font-bold ">
+                404|
+              </span>{' '}
+              No resources found.
             </p>
           </div>
         )}