feat(search): allow enabling detailed view by default

closes #2690
vuejs · Aug 3, 2023 · 4af5975 · 4af5975
1 parent 1179484
commit 4af5975
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/src/client/theme-default/components/VPLocalSearchBox.vue b/src/client/theme-default/components/VPLocalSearchBox.vue
@@ -104,13 +104,15 @@ const filterText = disableQueryPersistence.value
 
 const showDetailedList = useLocalStorage(
   'vitepress:local-search-detailed-list',
-  false
+  theme.value.search?.provider === 'local' &&
+    theme.value.search.options?.detailedView === true
 )
 
 const disableDetailedView = computed(() => {
   return (
     theme.value.search?.provider === 'local' &&
-    theme.value.search.options?.disableDetailedView === true
+    (theme.value.search.options?.disableDetailedView === true ||
+      theme.value.search.options?.detailedView === false)
   )
 })
 

diff --git a/types/default-theme.d.ts b/types/default-theme.d.ts
@@ -331,9 +331,19 @@ export namespace DefaultTheme {
   export interface LocalSearchOptions {
     /**
      * @default false
+     * @deprecated Use `detailedView: false` instead.
      */
     disableDetailedView?: boolean
 
+    /**
+     * If `true`, the detailed view will be enabled by default.
+     * If `false`, the detailed view will be disabled.
+     * If `'auto'`, the detailed view will be disabled by default, but can be enabled by the user.
+     *
+     * @default 'auto'
+     */
+    detailedView?: boolean | 'auto'
+
     /**
      * @default false
      */