Skip to content

Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active

refactor: Consolidate Message Scrolling & other Logic to Custom Hooks 🔄 (#1257)

Danny Avila4674a54c70ee
diff --git a/client/src/common/types.ts b/client/src/common/types.ts
index e65bd3221f..2ac16bb38c 100644
--- a/client/src/common/types.ts
+++ b/client/src/common/types.ts
@@ -112,7 +112,6 @@ export type TMessageProps = {
isSearchView?: boolean;
siblingIdx?: number;
siblingCount?: number;
- scrollToBottom?: () => void;
setCurrentEditId?: React.Dispatch<React.SetStateAction<string | number | null>> | null;
setSiblingIdx?: ((value: number) => void | React.Dispatch<React.SetStateAction<number>>) | null;
};
diff --git a/client/src/components/Chat/Input/Files/Image.tsx b/client/src/components/Chat/Input/Files/Image.tsx
index 7dbc81a519..fcf1dfe8c9 100644
--- a/client/src/components/Chat/Input/Files/Image.tsx
+++ b/client/src/components/Chat/Input/Files/Image.tsx
@@ -68,7 +68,6 @@ const Image = ({
cx="60"
cy="60"
/>
- {/* <circle className="origin-[50%_50%] -rotate-90 transition-[stroke-dashoffset]" stroke="currentColor" strokeWidth="10" strokeDashoffset="311.01767270538954" strokeDasharray="345.57519189487726 345.57519189487726" fill="transparent" r="55" cx="60" cy="60"/>*/}
<circle
className="origin-[50%_50%] -rotate-90 transition-[stroke-dashoffset]"
stroke="currentColor"
diff --git a/client/src/components/Chat/Input/PopoverButtons.tsx b/client/src/components/Chat/Input/PopoverButtons.tsx
index f29331f641..9c9e6b9043 100644
--- a/client/src/components/Chat/Input/PopoverButtons.tsx
+++ b/client/src/components/Chat/Input/PopoverButtons.tsx
@@ -2,7 +2,7 @@ import { EModelEndpoint } from 'librechat-data-provider';
import type { ReactNode } from 'react';
import { MessagesSquared, GPTIcon } from '~/components/svg';
import { useChatContext } from '~/Providers';
-import { Button } from '~/components';
+import { Button } from '~/components/ui';
import { cn } from '~/utils/';
type TPopoverButton = {
diff --git a/client/src/components/Chat/Messages/Message.tsx b/client/src/components/Chat/Messages/Message.tsx
index 1d3dfc4de4..658e7fa5a4 100644
--- a/client/src/components/Chat/Messages/Message.tsx
+++ b/client/src/components/Chat/Messages/Message.tsx
@@ -1,121 +1,39 @@
-/* eslint-disable react-hooks/exhaustive-deps */
-import { useEffect } from 'react';
-import copy from 'copy-to-clipboard';
-import { useRecoilValue } from 'recoil';
import { Plugin } from '~/components/Messages/Content';
import MessageContent from './Content/MessageContent';
-import { Icon } from '~/components/Endpoints';
-import SiblingSwitch from './SiblingSwitch';
import type { TMessageProps } from '~/common';
-import { useChatContext } from '~/Providers';
+import SiblingSwitch from './SiblingSwitch';
+import { useMessageHelpers } from '~/hooks';
// eslint-disable-next-line import/no-cycle
import MultiMessage from './MultiMessage';
import HoverButtons from './HoverButtons';
import SubRow from './SubRow';
import { cn } from '~/utils';
-import store from '~/store';
export default function Message(props: TMessageProps) {
- const autoScroll = useRecoilValue(store.autoScroll);
- const {
- message,
- scrollToBottom,
- currentEditId,
- setCurrentEditId,
- siblingIdx,
- siblingCount,
- setSiblingIdx,
- } = props;
+ const { message, siblingIdx, siblingCount, setSiblingIdx, currentEditId, setCurrentEditId } =
+ props;
const {
ask,
- regenerate,
- abortScroll,
- isSubmitting,
+ icon,
+ edit,
+ isLast,
+ enterEdit,
+ handleScroll,
conversation,
- setAbortScroll,
- handleContinue,
+ isSubmitting,
latestMessage,
- setLatestMessage,
- } = useChatContext();
-
- const { conversationId } = conversation ?? {};
+ handleContinue,
+ copyToClipboard,
+ regenerateMessage,
+ } = useMessageHelpers(props);
const { text, children, messageId = null, isCreatedByUser, error, unfinished } = message ?? {};
- const isLast = !children?.length;
- const edit = messageId === currentEditId;
-
- useEffect(() => {
- if (isSubmitting && scrollToBottom && !abortScroll) {
- scrollToBottom();
- }
- }, [isSubmitting, text, scrollToBottom, abortScroll]);
-
- useEffect(() => {
- if (scrollToBottom && autoScroll && conversationId !== 'new') {
- scrollToBottom();
- }
- }, [autoScroll, conversationId, scrollToBottom]);
-
- useEffect(() => {
- if (!message) {
- return;
- } else if (isLast) {
- setLatestMessage({ ...message });
- }
- }, [isLast, message, setLatestMessage]);
-
if (!message) {
return null;
}
- const enterEdit = (cancel?: boolean) =>
- setCurrentEditId && setCurrentEditId(cancel ? -1 : messageId);
-
- const handleScroll = () => {
- if (isSubmitting) {
- setAbortScroll(true);
- } else {
- setAbortScroll(false);
- }
- };
-
- // const commonClasses =
- // 'w-full border-b text-gray-800 group border-black/10 dark:border-gray-900/50 dark:text-gray-100 dark:border-none';
- // const uniqueClasses = isCreatedByUser
- // ? 'bg-white dark:bg-gray-800 dark:text-gray-20'
- // : 'bg-white dark:bg-gray-800 dark:text-gray-70';
-
- // const messageProps = {
- // className: cn(commonClasses, uniqueClasses),
- // titleclass: '',
- // };
-
- const icon = Icon({
- ...conversation,
- ...message,
- model: message?.model ?? conversation?.model,
- size: 28.8,
- });
-
- const regenerateMessage = () => {
- if (isSubmitting && isCreatedByUser) {
- return;
- }
-
- regenerate(message);
- };
-
- const copyToClipboard = (setIsCopied: React.Dispatch<React.SetStateAction<boolean>>) => {
- setIsCopied(true);
- copy(text ?? '');
-
- setTimeout(() => {
- setIsCopied(false);
- }, 3000);
- };
-
return (
<>
<div
@@ -198,7 +116,6 @@ export default function Message(props: TMessageProps) {
messageId={messageId}
conversation={conversation}
messagesTree={children ?? []}
- scrollToBottom={scrollToBottom}
currentEditId={currentEditId}
setCurrentEditId={setCurrentEditId}
/>
diff --git a/client/src/components/Chat/Messages/MessagesView.tsx b/client/src/components/Chat/Messages/MessagesView.tsx
index 3be5a51129..6130f33a10 100644
--- a/client/src/components/Chat/Messages/MessagesView.tsx
+++ b/client/src/components/Chat/Messages/MessagesView.tsx
@@ -1,10 +1,9 @@
-import { useLayoutEffect, useState, useRef, useCallback } from 'react';
+import { useState } from 'react';
import type { ReactNode } from 'react';
import type { TMessage } from 'librechat-data-provider';
import ScrollToBottom from '~/components/Messages/ScrollToBottom';
-import { useScreenshot, useScrollToRef } from '~/hooks';
+import { useScreenshot, useMessageScrolling } from '~/hooks';
import { CSSTransition } from 'react-transition-group';
-import { useChatContext } from '~/Providers';
import MultiMessage from './MultiMessage';
export default function MessagesView({
@@ -14,54 +13,19 @@ export default function MessagesView({
messagesTree?: TMessage[] | null;
Header?: ReactNode;
}) {
- const timeoutIdRef = useRef<NodeJS.Timeout>();
- const scrollableRef = useRef<HTMLDivElement | null>(null);
- const messagesEndRef = useRef<HTMLDivElement | null>(null);
- const [showScrollButton, setShowScrollButton] = useState(false);
- const [currentEditId, setCurrentEditId] = useState<number | string | null>(-1);
- const { conversation, setAbortScroll } = useChatContext();
- const { conversationId } = conversation ?? {};
-
const { screenshotTargetRef } = useScreenshot();
+ const [currentEditId, setCurrentEditId] = useState<number | string | null>(-1);
- const checkIfAtBottom = useCallback(() => {
- if (!scrollableRef.current) {
- return;
- }
-
- const { scrollTop, scrollHeight, clientHeight } = scrollableRef.current;
- const diff = Math.abs(scrollHeight - scrollTop);
- const percent = Math.abs(clientHeight - diff) / clientHeight;
- const hasScrollbar = scrollHeight > clientHeight && percent >= 0.15;
- setShowScrollButton(hasScrollbar);
- }, [scrollableRef]);
-
- useLayoutEffect(() => {
- const scrollableElement = scrollableRef.current;
- if (!scrollableElement) {
- return;
- }
- const timeoutId = setTimeout(checkIfAtBottom, 650);
-
- return () => {
- clearTimeout(timeoutId);
- };
- }, [checkIfAtBottom]);
-
- const debouncedHandleScroll = useCallback(() => {
- clearTimeout(timeoutIdRef.current);
- timeoutIdRef.current = setTimeout(checkIfAtBottom, 100);
- }, [checkIfAtBottom]);
+ const {
+ conversation,
+ scrollableRef,
+ messagesEndRef,
+ showScrollButton,
+ handleSmoothToRef,
+ debouncedHandleScroll,
+ } = useMessageScrolling(_messagesTree);
- const scrollCallback = () => setShowScrollButton(false);
- const { scrollToRef: scrollToBottom, handleSmoothToRef } = useScrollToRef({
- targetRef: messagesEndRef,
- callback: scrollCallback,
- smoothCallback: () => {
- scrollCallback();
- setAbortScroll(false);
- },
- });
+ const { conversationId } = conversation ?? {};
return (
<div className="flex-1 overflow-hidden overflow-y-auto">
@@ -86,9 +50,8 @@ export default function MessagesView({
<div ref={screenshotTargetRef}>
<MultiMessage
key={conversationId} // avoid internal state mixture
- messageId={conversationId ?? null}
messagesTree={_messagesTree}
- scrollToBottom={scrollToBottom}
+ messageId={conversationId ?? null}
setCurrentEditId={setCurrentEditId}
currentEditId={currentEditId ?? null}
/>
diff --git a/client/src/components/Chat/Messages/MultiMessage.tsx b/client/src/components/Chat/Messages/MultiMessage.tsx
index a1afbcc536..a62e9d384f 100644
--- a/client/src/components/Chat/Messages/MultiMessage.tsx
+++ b/client/src/components/Chat/Messages/MultiMessage.tsx
@@ -9,7 +9,6 @@ export default function MultiMessage({
// messageId is used recursively here
messageId,
messagesTree,
- scrollToBottom,
currentEditId,
setCurrentEditId,
}: TMessageProps) {
@@ -45,7 +44,6 @@ export default function MultiMessage({
<Message
key={message.messageId}
message={message}
- scrollToBottom={scrollToBottom}
currentEditId={currentEditId}
setCurrentEditId={setCurrentEditId}
siblingIdx={messagesTree.length - siblingIdx - 1}
diff --git a/client/src/components/Endpoints/Icon.tsx b/client/src/components/Endpoints/Icon.tsx
index 5883f3106f..0c0dcfd94b 100644
--- a/client/src/components/Endpoints/Icon.tsx
+++ b/client/src/components/Endpoints/Icon.tsx
@@ -1,6 +1,6 @@
import { EModelEndpoint } from 'librechat-data-provider';
import { Plugin, GPTIcon, AnthropicIcon, AzureMinimalIcon } from '~/components/svg';
-import { useAuthContext } from '~/hooks';
+import { useAuthContext } from '~/hooks/AuthContext';
import { IconProps } from '~/common';
import { cn } from '~/utils';
diff --git a/client/src/hooks/Messages/index.ts b/client/src/hooks/Messages/index.ts
new file mode 100644
index 0000000000..26d8b2b2cc
--- /dev/null
+++ b/client/src/hooks/Messages/index.ts
@@ -0,0 +1,2 @@
+export { default as useMessageHelpers } from './useMessageHelpers';
+export { default as useMessageScrolling } from './useMessageScrolling';
diff --git a/client/src/hooks/Messages/useMessageHelpers.ts b/client/src/hooks/Messages/useMessageHelpers.ts
new file mode 100644
index 0000000000..54e9924d74
--- /dev/null
+++ b/client/src/hooks/Messages/useMessageHelpers.ts
@@ -0,0 +1,83 @@
+import { useEffect } from 'react';
+import copy from 'copy-to-clipboard';
+import type { TMessage } from 'librechat-data-provider';
+import type { TMessageProps } from '~/common';
+import Icon from '~/components/Endpoints/Icon';
+import { useChatContext } from '~/Providers';
+
+export default function useMessageHelpers(props: TMessageProps) {
+ const { message, currentEditId, setCurrentEditId } = props;
+
+ const {
+ ask,
+ regenerate,
+ isSubmitting,
+ conversation,
+ latestMessage,
+ setAbortScroll,
+ handleContinue,
+ setLatestMessage,
+ } = useChatContext();
+
+ const { text, children, messageId = null, isCreatedByUser } = message ?? {};
+ const edit = messageId === currentEditId;
+ const isLast = !children?.length;
+
+ useEffect(() => {
+ if (!message) {
+ return;
+ } else if (isLast) {
+ setLatestMessage({ ...message });
+ }
+ }, [isLast, message, setLatestMessage]);
+
+ const enterEdit = (cancel?: boolean) =>
+ setCurrentEditId && setCurrentEditId(cancel ? -1 : messageId);
+
+ const handleScroll = () => {
+ if (isSubmitting) {
+ setAbortScroll(true);
+ } else {
+ setAbortScroll(false);
+ }
+ };
+
+ const icon = Icon({
+ ...conversation,
+ ...(message as TMessage),
+ model: message?.model ?? conversation?.model,
+ size: 28.8,
+ });
+
+ const regenerateMessage = () => {
+ if ((isSubmitting && isCreatedByUser) || !message) {
+ return;
+ }
+
+ regenerate(message);
+ };
+
+ const copyToClipboard = (setIsCopied: React.Dispatch<React.SetStateAction<boolean>>) => {
+ setIsCopied(true);
+ copy(text ?? '');
+
+ setTimeout(() => {
+ setIsCopied(false);
+ }, 3000);
+ };
+
+ return {
+ ask,
+ icon,
+ edit,
+ isLast,
+ enterEdit,
+ conversation,
+ isSubmitting,
+ handleScroll,
+ latestMessage,
+ handleContinue,
+ copyToClipboard,
+ regenerateMessage,
+ };
+}
diff --git a/client/src/hooks/Messages/useMessageScrolling.ts b/client/src/hooks/Messages/useMessageScrolling.ts
new file mode 100644
index 0000000000..a523e0b17e
--- /dev/null
+++ b/client/src/hooks/Messages/useMessageScrolling.ts
@@ -0,0 +1,83 @@
+import { useRecoilValue } from 'recoil';
+import { useLayoutEffect, useState, useRef, useCallback, useEffect } from 'react';
+import type { TMessage } from 'librechat-data-provider';
+import useScrollToRef from '../useScrollToRef';
+import { useChatContext } from '~/Providers';
+import store from '~/store';
+
+export default function useMessageScrolling(messagesTree?: TMessage[] | null) {
+ const autoScroll = useRecoilValue(store.autoScroll);
+
+ const timeoutIdRef = useRef<NodeJS.Timeout>();
+ const scrollableRef = useRef<HTMLDivElement | null>(null);
+ const messagesEndRef = useRef<HTMLDivElement | null>(null);
+ const [showScrollButton, setShowScrollButton] = useState(false);
+ const { conversation, setAbortScroll, isSubmitting, abortScroll } = useChatContext();
+ const { conversationId } = conversation ?? {};
+
+ const checkIfAtBottom = useCallback(() => {
+ if (!scrollableRef.current) {
+ return;
+ }
+
+ const { scrollTop, scrollHeight, clientHeight } = scrollableRef.current;
+ const diff = Math.abs(scrollHeight - scrollTop);
+ const percent = Math.abs(clientHeight - diff) / clientHeight;
+ const hasScrollbar = scrollHeight > clientHeight && percent >= 0.15;
+ setShowScrollButton(hasScrollbar);
+ }, [scrollableRef]);
+
+ useLayoutEffect(() => {
+ const scrollableElement = scrollableRef.current;
+ if (!scrollableElement) {
+ return;
+ }
+ const timeoutId = setTimeout(checkIfAtBottom, 650);
+
+ return () => {
+ clearTimeout(timeoutId);
+ };
+ }, [checkIfAtBottom]);
+
+ const debouncedHandleScroll = useCallback(() => {
+ clearTimeout(timeoutIdRef.current);
+ timeoutIdRef.current = setTimeout(checkIfAtBottom, 100);
+ }, [checkIfAtBottom]);
+
+ const scrollCallback = () => setShowScrollButton(false);
+
+ const { scrollToRef: scrollToBottom, handleSmoothToRef } = useScrollToRef({
+ targetRef: messagesEndRef,
+ callback: scrollCallback,
+ smoothCallback: () => {
+ scrollCallback();
+ setAbortScroll(false);
+ },
+ });
+
+ useEffect(() => {
+ if (!messagesTree) {
+ return;
+ }
+
+ if (isSubmitting && scrollToBottom && !abortScroll) {
+ scrollToBottom();
+ }
+ }, [isSubmitting, messagesTree, scrollToBottom, abortScroll]);
+
+ useEffect(() => {
+ if (scrollToBottom && autoScroll && conversationId !== 'new') {
+ scrollToBottom();
+ }
+ }, [autoScroll, conversationId, scrollToBottom]);
+
+ return {
+ conversation,
+ scrollableRef,
+ messagesEndRef,
+ scrollToBottom,
+ showScrollButton,
+ handleSmoothToRef,
+ debouncedHandleScroll,
+ };
+}
diff --git a/client/src/hooks/index.ts b/client/src/hooks/index.ts
index 2cfa2a9f2b..c6ba2e27ff 100644
--- a/client/src/hooks/index.ts
+++ b/client/src/hooks/index.ts
@@ -1,3 +1,5 @@
+export * from './Messages';
+
export * from './AuthContext';
export * from './ThemeContext';
export * from './ScreenshotContext';
diff --git a/client/src/hooks/useScrollToRef.ts b/client/src/hooks/useScrollToRef.ts
index 57369c635c..941fa5aac7 100644
--- a/client/src/hooks/useScrollToRef.ts
+++ b/client/src/hooks/useScrollToRef.ts
@@ -8,29 +8,22 @@ type TUseScrollToRef = {
};
export default function useScrollToRef({ targetRef, callback, smoothCallback }: TUseScrollToRef) {
+ const logAndScroll = (behavior: 'instant' | 'smooth', callbackFn: () => void) => {
+ // Debugging:
+ // console.log(`Scrolling with behavior: ${behavior}, Time: ${new Date().toISOString()}`);
+ targetRef.current?.scrollIntoView({ behavior });
+ callbackFn();
+ };
+
// eslint-disable-next-line react-hooks/exhaustive-deps
const scrollToRef = useCallback(
- throttle(
- () => {
- targetRef.current?.scrollIntoView({ behavior: 'instant' });
- callback();
- },
- 450,
- { leading: true },
- ),
+ throttle(() => logAndScroll('instant', callback), 450, { leading: true }),
[targetRef],
);
// eslint-disable-next-line react-hooks/exhaustive-deps
const scrollToRefSmooth = useCallback(
- throttle(
- () => {
- targetRef.current?.scrollIntoView({ behavior: 'smooth' });
- smoothCallback();
- },
- 750,
- { leading: true },
- ),
+ throttle(() => logAndScroll('smooth', smoothCallback), 750, { leading: true }),
[targetRef],
);