✨ feat: Add Settings Intercepting Routes (lobehub#2346)

* ♻️ refactor: Refactor Setting Layout * ♻️ refactor: Update useQueryRoute and add test * ✅ test: Update test * ✨ feat: Add Settings Intercepting Routes * ♻️ refactor: Refactor Setting Layout * ♻️ refactor: Update useQueryRoute and add test * ✅ test: Update test * 🐛 fix: Fix i18n * 💄 style: Fix style * 🐛 fix: Fix review problem * 🐛 fix: Fix review problem * ✅ test: Add useInterceptingRoutes.test * 🐛 fix: Fix config * 🐛 fix: Fix some merge problem * 🐛 fix: Fix modal layout * 🐛 fix: Fix cubox * 🐛 fix: Fix cubox * ✅ test: Fix test * 🐛 fix: Fix redirect * 🐛 fix: Fix review problem --------- Co-authored-by: Arvin Xu <arvinx@foxmail.com>
ipoly · Jul 29, 2024 · fe90bb1 · fe90bb1
1 parent 03eb9fb
commit fe90bb1
Show file tree

Hide file tree

Showing 53 changed files with 683 additions and 112 deletions.
diff --git a/locales/ar/common.json b/locales/ar/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "تقديم ملاحظات",
   "follow": "تابعنا على {{name}}",
+  "fullscreen": "وضع كامل الشاشة",
   "historyRange": "نطاق التاريخ",
   "import": "استيراد الإعدادات",
   "importModal": {

diff --git a/locales/bg-BG/common.json b/locales/bg-BG/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "Обратна връзка",
   "follow": "Следете ни на {{name}}",
+  "fullscreen": "Цял екран",
   "historyRange": "Диапазон на историята",
   "import": "Импортирай конфигурация",
   "importModal": {

diff --git a/locales/de-DE/common.json b/locales/de-DE/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "Feedback und Vorschläge",
   "follow": "Folge uns auf {{name}}",
+  "fullscreen": "Vollbildmodus",
   "historyRange": "Verlaufsbereich",
   "import": "Importieren",
   "importModal": {

diff --git a/locales/en-US/common.json b/locales/en-US/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "Feedback",
   "follow": "Follow us on {{name}}",
+  "fullscreen": "Full Screen Mode",
   "historyRange": "History Range",
   "import": "Import Configuration",
   "importModal": {

diff --git a/locales/es-ES/common.json b/locales/es-ES/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "Comentarios y sugerencias",
   "follow": "Síguenos en {{name}}",
+  "fullscreen": "Pantalla completa",
   "historyRange": "Rango de historial",
   "import": "Importar configuración",
   "importModal": {

diff --git a/locales/fr-FR/common.json b/locales/fr-FR/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "Retour d'information et suggestions",
   "follow": "Suivez-nous sur {{name}}",
+  "fullscreen": "Mode plein écran",
   "historyRange": "Plage d'historique",
   "import": "Importer",
   "importModal": {

diff --git a/locales/it-IT/common.json b/locales/it-IT/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "Feedback e suggerimenti",
   "follow": "Seguici su {{name}}",
+  "fullscreen": "Modalità a schermo intero",
   "historyRange": "Intervallo cronologico",
   "import": "Importa configurazione",
   "importModal": {

diff --git a/locales/ja-JP/common.json b/locales/ja-JP/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "フィードバック",
   "follow": " {{name}} で私たちをフォローする",
+  "fullscreen": "フルスクリーンモード",
   "historyRange": "履歴範囲",
   "import": "インポート",
   "importModal": {

diff --git a/locales/ko-KR/common.json b/locales/ko-KR/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "피드백 및 제안",
   "follow": "{{name}}에서 우리를 팔로우하세요",
+  "fullscreen": "전체 화면",
   "historyRange": "기록 범위",
   "import": "가져오기",
   "importModal": {

diff --git a/locales/nl-NL/common.json b/locales/nl-NL/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "Feedback en suggesties",
   "follow": "Volg ons op {{name}}",
+  "fullscreen": "Volledig scherm",
   "historyRange": "Geschiedenisbereik",
   "import": "Importeren",
   "importModal": {

diff --git a/locales/pl-PL/common.json b/locales/pl-PL/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "Opinie i sugestie",
   "follow": "Zaobserwuj nas na {{name}}",
+  "fullscreen": "Tryb pełnoekranowy",
   "historyRange": "Zakres historii",
   "import": "Importuj ustawienia",
   "importModal": {

diff --git a/locales/pt-BR/common.json b/locales/pt-BR/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "Feedback e sugestões",
   "follow": "Siga-nos no {{name}}",
+  "fullscreen": "Modo de Tela Cheia",
   "historyRange": "Intervalo de histórico",
   "import": "Importar configuração",
   "importModal": {

diff --git a/locales/ru-RU/common.json b/locales/ru-RU/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "Обратная связь и предложения",
   "follow": "Подпишитесь на нас на {{name}}",
+  "fullscreen": "Полноэкранный режим",
   "historyRange": "История",
   "import": "Импорт настроек",
   "importModal": {

diff --git a/locales/tr-TR/common.json b/locales/tr-TR/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "Feedback",
   "follow": "Bizi {{name}} üzerinde takip edin",
+  "fullscreen": "Tam Ekran Modu",
   "historyRange": "Geçmiş Aralığı",
   "import": "İçe Aktar",
   "importModal": {

diff --git a/locales/vi-VN/common.json b/locales/vi-VN/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "Phản hồi và đề xuất",
   "follow": "Theo dõi chúng tôi trên {{name}}",
+  "fullscreen": "Chế độ toàn màn hình",
   "historyRange": "Phạm vi lịch sử",
   "import": "Nhập cấu hình",
   "importModal": {

diff --git a/locales/zh-CN/common.json b/locales/zh-CN/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "反馈与建议",
   "follow": "在 {{name}} 上关注我们",
+  "fullscreen": "全屏模式",
   "historyRange": "历史范围",
   "import": "导入配置",
   "importModal": {

diff --git a/locales/zh-TW/common.json b/locales/zh-TW/common.json
@@ -28,6 +28,7 @@
   },
   "feedback": "回饋與建議",
   "follow": "在 {{name}} 上關注我們",
+  "fullscreen": "全螢幕模式",
   "historyRange": "歷史範圍",
   "import": "匯入設定",
   "importModal": {

diff --git a/src/app/(main)/chat/(desktop)/features/ChatHeader/Main.tsx b/src/app/(main)/chat/(desktop)/features/ChatHeader/Main.tsx
@@ -1,21 +1,18 @@
 import { Avatar, ChatHeaderTitle } from '@lobehub/ui';
 import { Skeleton } from 'antd';
-import { useRouter } from 'next/navigation';
 import { memo } from 'react';
 import { useTranslation } from 'react-i18next';
 import { Flexbox } from 'react-layout-kit';
 
+import { useOpenChatSettings } from '@/hooks/useInterceptingRoutes';
 import { useSessionStore } from '@/store/session';
 import { sessionMetaSelectors, sessionSelectors } from '@/store/session/selectors';
-import { pathString } from '@/utils/url';
 
 import Tags from './Tags';
 
 const Main = memo(() => {
   const { t } = useTranslation('chat');
 
-  const router = useRouter();
-
   const [init, isInbox, title, description, avatar, backgroundColor] = useSessionStore((s) => [
     sessionSelectors.isSomeSessionActive(s),
     sessionSelectors.isInboxSession(s),
@@ -25,6 +22,8 @@ const Main = memo(() => {
     sessionMetaSelectors.currentAgentBackgroundColor(s),
   ]);
 
+  const openChatSettings = useOpenChatSettings();
+
   const displayTitle = isInbox ? t('inbox.title') : title;
   const displayDesc = isInbox ? t('inbox.desc') : description;
 
@@ -42,11 +41,7 @@ const Main = memo(() => {
       <Avatar
         avatar={avatar}
         background={backgroundColor}
-        onClick={() =>
-          isInbox
-            ? router.push('/settings/agent')
-            : router.push(pathString('/chat/settings', { search: location.search }))
-        }
+        onClick={openChatSettings}
         size={40}
         title={title}
       />

diff --git a/src/app/(main)/chat/(desktop)/features/SideBar/SystemRole/index.tsx b/src/app/(main)/chat/(desktop)/features/SideBar/SystemRole/index.tsx
@@ -1,28 +1,27 @@
 import { ActionIcon, EditableMessage } from '@lobehub/ui';
 import { Skeleton } from 'antd';
 import { Edit } from 'lucide-react';
-import { useRouter } from 'next/navigation';
 import { memo, useState } from 'react';
 import { useTranslation } from 'react-i18next';
 import { Flexbox } from 'react-layout-kit';
 import useMergeState from 'use-merge-value';
 
+import SidebarHeader from '@/components/SidebarHeader';
 import AgentInfo from '@/features/AgentInfo';
+import { useOpenChatSettings } from '@/hooks/useInterceptingRoutes';
 import { useAgentStore } from '@/store/agent';
 import { agentSelectors } from '@/store/agent/selectors';
 import { useGlobalStore } from '@/store/global';
+import { ChatSettingsTabs } from '@/store/global/initialState';
 import { useSessionStore } from '@/store/session';
 import { sessionMetaSelectors, sessionSelectors } from '@/store/session/selectors';
-import { pathString } from '@/utils/url';
 
-import SidebarHeader from '../../../../components/SidebarHeader';
 import { useStyles } from './style';
 
 const SystemRole = memo(() => {
-  const router = useRouter();
   const [editing, setEditing] = useState(false);
   const { styles } = useStyles();
-
+  const openChatSettings = useOpenChatSettings(ChatSettingsTabs.Prompt);
   const [init, meta] = useSessionStore((s) => [
     sessionSelectors.isSomeSessionActive(s),
     sessionMetaSelectors.currentAgentMeta(s),
@@ -93,7 +92,7 @@ const SystemRole = memo(() => {
                     onAvatarClick={() => {
                       setOpen(false);
                       setEditing(false);
-                      router.push(pathString('/chat/settings', { search: location.search }));
+                      openChatSettings();
                     }}
                     style={{ marginBottom: 16 }}
                   />

diff --git a/src/app/(main)/chat/features/SettingButton.tsx b/src/app/(main)/chat/features/SettingButton.tsx
@@ -4,30 +4,16 @@ import { memo } from 'react';
 import { useTranslation } from 'react-i18next';
 
 import { DESKTOP_HEADER_ICON_SIZE, MOBILE_HEADER_ICON_SIZE } from '@/const/layoutTokens';
-import { useQueryRoute } from '@/hooks/useQueryRoute';
-import { useGlobalStore } from '@/store/global';
-import { SidebarTabKey } from '@/store/global/initialState';
-import { useSessionStore } from '@/store/session';
-import { sessionSelectors } from '@/store/session/selectors';
+import { useOpenChatSettings } from '@/hooks/useInterceptingRoutes';
 
 const SettingButton = memo<{ mobile?: boolean }>(({ mobile }) => {
-  const isInbox = useSessionStore(sessionSelectors.isInboxSession);
   const { t } = useTranslation('common');
-  const router = useQueryRoute();
+  const openChatSettings = useOpenChatSettings();
 
   return (
     <ActionIcon
       icon={AlignJustify}
-      onClick={() => {
-        if (isInbox) {
-          useGlobalStore.setState({
-            sidebarKey: SidebarTabKey.Setting,
-          });
-          router.push('/settings/agent');
-        } else {
-          router.push('/chat/settings');
-        }
-      }}
+      onClick={openChatSettings}
       size={mobile ? MOBILE_HEADER_ICON_SIZE : DESKTOP_HEADER_ICON_SIZE}
       title={t('header.session', { ns: 'setting' })}
     />

diff --git a/src/app/(main)/chat/features/TopicListContent/Header.tsx b/src/app/(main)/chat/features/TopicListContent/Header.tsx
@@ -5,10 +5,10 @@ import { memo, useMemo, useState } from 'react';
 import { useTranslation } from 'react-i18next';
 import { Flexbox } from 'react-layout-kit';
 
+import SidebarHeader from '@/components/SidebarHeader';
 import { useChatStore } from '@/store/chat';
 import { topicSelectors } from '@/store/chat/selectors';
 
-import SidebarHeader from '../../components/SidebarHeader';
 import TopicSearchBar from './TopicSearchBar';
 
 const Header = memo(() => {

diff --git a/src/app/(main)/chat/settings/_layout/Desktop/Header.tsx b/src/app/(main)/chat/settings/_layout/Desktop/Header.tsx
@@ -5,9 +5,10 @@ import { useRouter } from 'next/navigation';
 import { memo } from 'react';
 import { useTranslation } from 'react-i18next';
 
-import HeaderContent from '@/app/(main)/chat/settings/features/HeaderContent';
 import { pathString } from '@/utils/url';
 
+import HeaderContent from '../../features/HeaderContent';
+
 const Header = memo(() => {
   const { t } = useTranslation('setting');
   const router = useRouter();

diff --git a/src/app/(main)/chat/settings/_layout/Mobile/Header.tsx b/src/app/(main)/chat/settings/_layout/Mobile/Header.tsx
@@ -5,10 +5,11 @@ import { useRouter } from 'next/navigation';
 import { memo } from 'react';
 import { useTranslation } from 'react-i18next';
 
-import HeaderContent from '@/app/(main)/chat/settings/features/HeaderContent';
 import { mobileHeaderSticky } from '@/styles/mobileHeader';
 import { pathString } from '@/utils/url';
 
+import HeaderContent from '../../features/HeaderContent';
+
 const Header = memo(() => {
   const { t } = useTranslation('setting');
   const router = useRouter();

diff --git a/src/app/(main)/chat/settings/modal/page.tsx b/src/app/(main)/chat/settings/modal/page.tsx
@@ -0,0 +1,23 @@
+'use client';
+
+import { useLayoutEffect } from 'react';
+
+import { useQueryRoute } from '@/hooks/useQueryRoute';
+
+/**
+ * @description: Chat Settings Modal (intercepting routes fallback when hard refresh)
+ * @example: /chat/settings/modal?tab=prompt => /chat/settings
+ * @refs: https://github.com/lobehub/lobe-chat/discussions/2295#discussioncomment-9290942
+ */
+
+const ChatSettingsModalFallback = () => {
+  const router = useQueryRoute();
+
+  useLayoutEffect(() => {
+    router.replace('/chat/settings', { query: { tab: '' } });
+  }, []);
+
+  return null;
+};
+
+export default ChatSettingsModalFallback;
diff --git a/src/app/(main)/settings/@category/features/CategoryContent.tsx b/src/app/(main)/settings/@category/features/CategoryContent.tsx
@@ -21,7 +21,11 @@ const CategoryContent = memo<{ modal?: boolean }>(({ modal }) => {
     <Menu
       items={cateItems}
       onClick={({ key }) => {
-        router.push(urlJoin('/settings', key));
+        if (modal) {
+          router.replace('/settings/modal', { query: { tab: key } });
+        } else {
+          router.push(urlJoin('/settings', key));
+        }
       }}
       selectable
       selectedKeys={[modal ? tab : (activeTab as any)]}

diff --git a/src/app/(main)/settings/modal/page.tsx b/src/app/(main)/settings/modal/page.tsx
@@ -0,0 +1,27 @@
+'use client';
+
+import { useLayoutEffect } from 'react';
+import urlJoin from 'url-join';
+
+import { useQuery } from '@/hooks/useQuery';
+import { useQueryRoute } from '@/hooks/useQueryRoute';
+import { SettingsTabs } from '@/store/global/initialState';
+
+/**
+ * @description: Settings Modal (intercepting routes fallback when hard refresh)
+ * @example: /settings/modal?tab=common => /settings/common
+ * @refs: https://github.com/lobehub/lobe-chat/discussions/2295#discussioncomment-9290942
+ */
+
+const SettingsModalFallback = () => {
+  const { tab = SettingsTabs.Common } = useQuery();
+  const router = useQueryRoute();
+
+  useLayoutEffect(() => {
+    router.replace(urlJoin('/settings', tab as SettingsTabs), { query: { tab: '' } });
+  }, []);
+
+  return null;
+};
+
+export default SettingsModalFallback;
diff --git a/src/app/@modal/(.)settings/modal/index.tsx b/src/app/@modal/(.)settings/modal/index.tsx
@@ -0,0 +1,40 @@
+'use client';
+
+import dynamic from 'next/dynamic';
+import { memo } from 'react';
+
+import { useQuery } from '@/hooks/useQuery';
+import { SettingsTabs } from '@/store/global/initialState';
+
+import Skeleton from './loading';
+
+const loading = () => <Skeleton />;
+
+const Common = dynamic(() => import('@/app/(main)/settings/common'), { loading, ssr: false });
+const About = dynamic(() => import('@/app/(main)/settings/about'), { loading, ssr: false });
+const LLM = dynamic(() => import('@/app/(main)/settings/llm'), { loading, ssr: false });
+const TTS = dynamic(() => import('@/app/(main)/settings/tts'), { loading, ssr: false });
+const Agent = dynamic(() => import('@/app/(main)/settings/agent'), { loading, ssr: false });
+const Sync = dynamic(() => import('@/app/(main)/settings/sync'), { loading, ssr: false });
+
+interface SettingsModalProps {
+  browser?: string;
+  mobile?: boolean;
+  os?: string;
+}
+
+const SettingsModal = memo<SettingsModalProps>(({ browser, os, mobile }) => {
+  const { tab = SettingsTabs.Common } = useQuery();
+  return (
+    <>
+      {tab === SettingsTabs.Common && <Common />}
+      {tab === SettingsTabs.Sync && <Sync browser={browser} mobile={mobile} os={os} />}
+      {tab === SettingsTabs.LLM && <LLM />}
+      {tab === SettingsTabs.TTS && <TTS />}
+      {tab === SettingsTabs.Agent && <Agent />}
+      {tab === SettingsTabs.About && <About mobile={mobile} />}
+    </>
+  );
+});
+
+export default SettingsModal;