From 4b918602274aa9ebbcd31037c79fdf4d2fbedf52 Mon Sep 17 00:00:00 2001
From: Chenlei Hu <huchenlei@proton.me>
Date: Sun, 24 Nov 2024 17:48:35 -0800
Subject: [PATCH] [Refactor] Extract SettingsPanel (#1673)

* [Refactor] Extract SettingsPanel

* nit
---
 .../dialog/content/SettingDialogContent.vue   | 53 ++++++-------------
 .../dialog/content/setting/SettingsPanel.vue  | 26 +++++++++
 src/types/settingTypes.ts                     |  5 ++
 3 files changed, 47 insertions(+), 37 deletions(-)
 create mode 100644 src/components/dialog/content/setting/SettingsPanel.vue

diff --git a/src/components/dialog/content/SettingDialogContent.vue b/src/components/dialog/content/SettingDialogContent.vue
index a4529ac6b..b3cc69a21 100644
--- a/src/components/dialog/content/SettingDialogContent.vue
+++ b/src/components/dialog/content/SettingDialogContent.vue
@@ -22,35 +22,14 @@
         <FirstTimeUIMessage v-if="tabValue === 'Comfy'" />
         <TabPanels class="settings-tab-panels">
           <TabPanel key="search-results" value="Search Results">
-            <div v-if="searchResults.length > 0">
-              <SettingGroup
-                v-for="(group, i) in searchResults"
-                :key="group.label"
-                :divider="i !== 0"
-                :group="group"
-              />
-            </div>
-            <NoResultsPlaceholder
-              v-else
-              icon="pi pi-search"
-              :title="$t('noResultsFound')"
-              :message="$t('searchFailedMessage')"
-            />
+            <SettingsPanel :settingGroups="searchResults" />
           </TabPanel>
           <TabPanel
-            v-for="category in categories"
+            v-for="category in settingCategories"
             :key="category.key"
             :value="category.label"
           >
-            <SettingGroup
-              v-for="(group, i) in sortedGroups(category)"
-              :key="group.label"
-              :divider="i !== 0"
-              :group="{
-                label: group.label,
-                settings: flattenTree<SettingParams>(group)
-              }"
-            />
+            <SettingsPanel :settingGroups="sortedGroups(category)" />
           </TabPanel>
           <TabPanel key="about" value="About">
             <AboutPanel />
@@ -94,10 +73,9 @@ import TabPanel from 'primevue/tabpanel'
 import Divider from 'primevue/divider'
 import ScrollPanel from 'primevue/scrollpanel'
 import { SettingTreeNode, useSettingStore } from '@/stores/settingStore'
-import { SettingParams } from '@/types/settingTypes'
-import SettingGroup from './setting/SettingGroup.vue'
+import { ISettingGroup, SettingParams } from '@/types/settingTypes'
+import SettingsPanel from './setting/SettingsPanel.vue'
 import SearchBox from '@/components/common/SearchBox.vue'
-import NoResultsPlaceholder from '@/components/common/NoResultsPlaceholder.vue'
 import { flattenTree } from '@/utils/treeUtil'
 import AboutPanel from './setting/AboutPanel.vue'
 import FirstTimeUIMessage from './setting/FirstTimeUIMessage.vue'
@@ -113,11 +91,6 @@ const ServerConfigPanel = defineAsyncComponent(
   () => import('./setting/ServerConfigPanel.vue')
 )
 
-interface ISettingGroup {
-  label: string
-  settings: SettingParams[]
-}
-
 const aboutPanelNode: SettingTreeNode = {
   key: 'about',
   label: 'About',
@@ -158,8 +131,11 @@ const serverConfigPanelNodeList = computed<SettingTreeNode[]>(() => {
 
 const settingStore = useSettingStore()
 const settingRoot = computed<SettingTreeNode>(() => settingStore.settingTree)
+const settingCategories = computed<SettingTreeNode[]>(
+  () => settingRoot.value.children ?? []
+)
 const categories = computed<SettingTreeNode[]>(() => [
-  ...(settingRoot.value.children || []),
+  ...settingCategories.value,
   keybindingPanelNode,
   ...extensionPanelNodeList.value,
   ...serverConfigPanelNodeList.value,
@@ -178,10 +154,13 @@ onMounted(() => {
   activeCategory.value = categories.value[0]
 })
 
-const sortedGroups = (category: SettingTreeNode) => {
-  return [...(category.children || [])].sort((a, b) =>
-    a.label.localeCompare(b.label)
-  )
+const sortedGroups = (category: SettingTreeNode): ISettingGroup[] => {
+  return [...(category.children ?? [])]
+    .sort((a, b) => a.label.localeCompare(b.label))
+    .map((group) => ({
+      label: group.label,
+      settings: flattenTree<SettingParams>(group)
+    }))
 }
 
 const searchQuery = ref<string>('')
diff --git a/src/components/dialog/content/setting/SettingsPanel.vue b/src/components/dialog/content/setting/SettingsPanel.vue
new file mode 100644
index 000000000..b0d99c65d
--- /dev/null
+++ b/src/components/dialog/content/setting/SettingsPanel.vue
@@ -0,0 +1,26 @@
+<template>
+  <div v-if="props.settingGroups.length > 0">
+    <SettingGroup
+      v-for="(group, i) in props.settingGroups"
+      :key="group.label"
+      :divider="i !== 0"
+      :group="group"
+    />
+  </div>
+  <NoResultsPlaceholder
+    v-else
+    icon="pi pi-search"
+    :title="$t('noResultsFound')"
+    :message="$t('searchFailedMessage')"
+  />
+</template>
+
+<script setup lang="ts">
+import NoResultsPlaceholder from '@/components/common/NoResultsPlaceholder.vue'
+import SettingGroup from './SettingGroup.vue'
+import { ISettingGroup } from '@/types/settingTypes'
+
+const props = defineProps<{
+  settingGroups: ISettingGroup[]
+}>()
+</script>
diff --git a/src/types/settingTypes.ts b/src/types/settingTypes.ts
index 24ebb2ec6..1985295ce 100644
--- a/src/types/settingTypes.ts
+++ b/src/types/settingTypes.ts
@@ -58,3 +58,8 @@ export interface FormItem {
   attrs?: Record<string, any>
   options?: Array<string | SettingOption> | ((value: any) => SettingOption[])
 }
+
+export interface ISettingGroup {
+  label: string
+  settings: SettingParams[]
+}