refactor(Nav): improve toggle animation, refactor to TS (#755)

* style(Nav): match transition effect of official site

* fix(Pages): fix bug when searchResults pageSize is < prev PageSize causes currentPage to be impossible value

* refactor/fix(Nav): fix width transition animation and refactor to TS

client/src/components/Conversations/Pages.tsx

@@ -1,10 +1,22 @@
 import React from 'react';
+import { PagesProps } from 'librechat-data-provider';
 
-export default function Pages({ pageNumber, pages, nextPage, previousPage }) {
+export default function Pages({
-  const clickHandler = (func) => async (e) => {
+  pageNumber,
-    e.preventDefault();
+  pages,
-    await func();
+  nextPage,
-  };
+  previousPage,
+  setPageNumber,
+}: PagesProps) {
+  const clickHandler =
+    (func: () => Promise<void>) => async (e: React.MouseEvent<HTMLButtonElement>) => {
+      e.preventDefault();
+      await func();
+    };
+
+  if (pageNumber > pages) {
+    setPageNumber(pages);
+  }
 
   return pageNumber == 1 && pages == 1 ? null : (
     <div className="m-auto mb-2 mt-4 flex items-center justify-center gap-2">

client/src/components/Nav/Nav.tsx

@@ -1,30 +1,46 @@
+import {
+  TConversation,
+  useGetConversationsQuery,
+  useSearchQuery,
+  TSearchResults,
+} from 'librechat-data-provider';
+import { useCallback, useEffect, useRef, useState } from 'react';
+import { useRecoilValue, useSetRecoilState } from 'recoil';
 import NewChat from './NewChat';
 import NavLinks from './NavLinks';
 import { Panel, Spinner } from '~/components';
 import { Conversations, Pages } from '../Conversations';
-import { useCallback, useEffect, useRef, useState } from 'react';
+import { useAuthContext, useDebounce, useMediaQuery, useLocalize } from '~/hooks';
-import { useGetConversationsQuery, useSearchQuery } from 'librechat-data-provider';
-import { useRecoilValue, useSetRecoilState } from 'recoil';
-import { useAuthContext, useDebounce } from '~/hooks';
-import { localize } from '~/localization/Translation';
 import { cn } from '~/utils/';
 import store from '~/store';
 
 export default function Nav({ navVisible, setNavVisible }) {
   const [isHovering, setIsHovering] = useState(false);
+  const [navWidth, setNavWidth] = useState('260px');
   const { isAuthenticated } = useAuthContext();
-  const containerRef = useRef(null);
+  const containerRef = useRef<HTMLDivElement | null>(null);
-  const scrollPositionRef = useRef(null);
+  const scrollPositionRef = useRef<number | null>(null);
-  const lang = useRecoilValue(store.lang);
+  const localize = useLocalize();
+  const isSmallScreen = useMediaQuery('(max-width: 768px)');
 
-  const [conversations, setConversations] = useState([]);
+  useEffect(() => {
+    if (isSmallScreen) {
+      setNavWidth('320px');
+    } else {
+      setNavWidth('260px');
+    }
+  }, [isSmallScreen]);
+
+  const [conversations, setConversations] = useState<TConversation[]>([]);
   // current page
   const [pageNumber, setPageNumber] = useState(1);
   // total pages
   const [pages, setPages] = useState(1);
 
   // data provider
-  const getConversationsQuery = useGetConversationsQuery(pageNumber, { enabled: isAuthenticated });
+  const getConversationsQuery = useGetConversationsQuery(pageNumber + '', {
+    enabled: isAuthenticated,
+  });
 
   // search
   const searchQuery = useRecoilValue(store.searchQuery);
@@ -42,22 +58,28 @@ export default function Nav({ navVisible, setNavVisible }) {
   const [isFetching, setIsFetching] = useState(false);
 
   const debouncedSearchTerm = useDebounce(searchQuery, 750);
-  const searchQueryFn = useSearchQuery(debouncedSearchTerm, pageNumber, {
+  const searchQueryFn = useSearchQuery(debouncedSearchTerm, pageNumber + '', {
-    enabled:
+    enabled: !!(
-      !!debouncedSearchTerm && debouncedSearchTerm.length > 0 && isSearchEnabled && isSearching,
+      !!debouncedSearchTerm &&
+      debouncedSearchTerm.length > 0 &&
+      isSearchEnabled &&
+      isSearching
+    ),
   });
 
-  const onSearchSuccess = (data, expectedPage) => {
+  const onSearchSuccess = useCallback((data: TSearchResults, expectedPage?: number) => {
     const res = data;
     setConversations(res.conversations);
     if (expectedPage) {
       setPageNumber(expectedPage);
     }
-    setPages(res.pages);
+    setPages(Number(res.pages));
     setIsFetching(false);
     searchPlaceholderConversation();
     setSearchResultMessages(res.messages);
-  };
+    /* disabled due recoil methods not recognized as state setters */
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []); // Empty dependency array
 
   useEffect(() => {
     //we use isInitialLoading here instead of isLoading because query is disabled by default
@@ -66,7 +88,7 @@ export default function Nav({ navVisible, setNavVisible }) {
     } else if (searchQueryFn.data) {
       onSearchSuccess(searchQueryFn.data);
     }
-  }, [searchQueryFn.data, searchQueryFn.isInitialLoading]);
+  }, [searchQueryFn.data, searchQueryFn.isInitialLoading, onSearchSuccess]);
 
   const clearSearch = () => {
     setPageNumber(1);
@@ -99,12 +121,13 @@ export default function Nav({ navVisible, setNavVisible }) {
         return;
       }
       let { conversations, pages } = getConversationsQuery.data;
+      pages = Number(pages);
       if (pageNumber > pages) {
         setPageNumber(pages);
       } else {
         if (!isSearching) {
           conversations = conversations.sort(
-            (a, b) => new Date(b.createdAt) - new Date(a.createdAt),
+            (a, b) => new Date(b.createdAt).getTime() - new Date(a.createdAt).getTime(),
           );
         }
         setConversations(conversations);
@@ -121,7 +144,7 @@ export default function Nav({ navVisible, setNavVisible }) {
   }, [pageNumber, conversationId, refreshConversationsHint]);
 
   const toggleNavVisible = () => {
-    setNavVisible((prev) => !prev);
+    setNavVisible((prev: boolean) => !prev);
   };
 
   const containerClasses =
@@ -132,10 +155,11 @@ export default function Nav({ navVisible, setNavVisible }) {
   return (
     <>
       <div
-        className="nav active dark max-w-[320px] flex-shrink-0 overflow-x-hidden bg-gray-900 transition-all duration-200 ease-in-out md:max-w-[260px]"
+        className="nav active dark max-w-[320px] flex-shrink-0 overflow-x-hidden bg-gray-900 md:max-w-[260px]"
         style={{
-          width: navVisible ? '100%' : '0%',
+          width: navVisible ? navWidth : '0px',
           visibility: navVisible ? 'visible' : 'hidden',
+          transition: 'width 0.2s, visibility 0.2s',
         }}
       >
         <div className="h-full w-[320px] md:w-[260px]">
@@ -151,7 +175,7 @@ export default function Nav({ navVisible, setNavVisible }) {
                     )}
                     onClick={toggleNavVisible}
                   >
-                    <span className="sr-only">{localize(lang, 'com_nav_close_sidebar')}</span>
+                    <span className="sr-only">{localize('com_nav_close_sidebar')}</span>
                     <Panel open={false} />
                   </button>
                 </div>
@@ -167,17 +191,14 @@ export default function Nav({ navVisible, setNavVisible }) {
                     {(getConversationsQuery.isLoading && pageNumber === 1) || isFetching ? (
                       <Spinner />
                     ) : (
-                      <Conversations
+                      <Conversations conversations={conversations} moveToTop={moveToTop} />
-                        conversations={conversations}
-                        conversationId={conversationId}
-                        moveToTop={moveToTop}
-                      />
                     )}
                     <Pages
                       pageNumber={pageNumber}
                       pages={pages}
                       nextPage={nextPage}
                       previousPage={previousPage}
+                      setPageNumber={setPageNumber}
                     />
                   </div>
                 </div>
@@ -195,7 +216,7 @@ export default function Nav({ navVisible, setNavVisible }) {
             onClick={toggleNavVisible}
           >
             <div className="flex items-center justify-center">
-              <span className="sr-only">{localize(lang, 'com_nav_open_sidebar')}</span>
+              <span className="sr-only">{localize('com_nav_open_sidebar')}</span>
               <Panel open={true} />
             </div>
           </button>

client/src/store/search.ts

@@ -1,3 +1,4 @@
+import { TMessage } from 'librechat-data-provider';
 import { atom, selector } from 'recoil';
 import { buildTree } from '~/utils';
 
@@ -11,7 +12,7 @@ const searchQuery = atom({
   default: '',
 });
 
-const searchResultMessages = atom({
+const searchResultMessages = atom<TMessage[] | null>({
   key: 'searchResultMessages',
   default: null,
 });

packages/data-provider/src/types.ts

@@ -467,3 +467,11 @@ export type CleanupPreset = {
   preset: Partial<TPreset>;
   endpointsConfig?: TEndpointsConfig | Record<string, unknown>;
 };
+
+export type PagesProps = {
+  pages: number;
+  pageNumber: number;
+  setPageNumber: (pageNumber: number) => void;
+  nextPage: () => Promise<void>;
+  previousPage: () => Promise<void>;
+};