feat(search): support custom disableQueryPersistence in local search (

#2273)
vuejs · Apr 24, 2023 · 2f0f2d5 · 2f0f2d5
1 parent 25b9111
commit 2f0f2d5
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/src/client/theme-default/components/VPLocalSearchBox.vue b/src/client/theme-default/components/VPLocalSearchBox.vue
@@ -81,7 +81,16 @@ const searchIndex = computedAsync(async () =>
   )
 )
 
-const filterText = useSessionStorage('vitepress:local-search-filter', '')
+const disableQueryPersistence = computed(() => {
+  return (
+      theme.value.search?.provider === 'local' &&
+      theme.value.search.options?.disableQueryPersistence === true
+  )
+})
+
+const filterText = disableQueryPersistence.value
+    ? ref('')
+    : useSessionStorage('vitepress:local-search-filter', '')
 
 const showDetailedList = useLocalStorage(
   'vitepress:local-search-detailed-list',

diff --git a/types/default-theme.d.ts b/types/default-theme.d.ts
@@ -298,6 +298,11 @@ export namespace DefaultTheme {
      */
     disableDetailedView?: boolean
 
+    /**
+     * @default false
+     */
+    disableQueryPersistence?: boolean
+
     translations?: LocalSearchTranslations
     locales?: Record<string, Partial<Omit<LocalSearchOptions, 'locales'>>>
   }