Skip to content

Commit 4af5975

Browse files
committed
feat(search): allow enabling detailed view by default
closes #2690
1 parent 1179484 commit 4af5975

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

src/client/theme-default/components/VPLocalSearchBox.vue

+4-2
Original file line numberDiff line numberDiff line change
@@ -104,13 +104,15 @@ const filterText = disableQueryPersistence.value
104104
105105
const showDetailedList = useLocalStorage(
106106
'vitepress:local-search-detailed-list',
107-
false
107+
theme.value.search?.provider === 'local' &&
108+
theme.value.search.options?.detailedView === true
108109
)
109110
110111
const disableDetailedView = computed(() => {
111112
return (
112113
theme.value.search?.provider === 'local' &&
113-
theme.value.search.options?.disableDetailedView === true
114+
(theme.value.search.options?.disableDetailedView === true ||
115+
theme.value.search.options?.detailedView === false)
114116
)
115117
})
116118

types/default-theme.d.ts

+10
Original file line numberDiff line numberDiff line change
@@ -331,9 +331,19 @@ export namespace DefaultTheme {
331331
export interface LocalSearchOptions {
332332
/**
333333
* @default false
334+
* @deprecated Use `detailedView: false` instead.
334335
*/
335336
disableDetailedView?: boolean
336337

338+
/**
339+
* If `true`, the detailed view will be enabled by default.
340+
* If `false`, the detailed view will be disabled.
341+
* If `'auto'`, the detailed view will be disabled by default, but can be enabled by the user.
342+
*
343+
* @default 'auto'
344+
*/
345+
detailedView?: boolean | 'auto'
346+
337347
/**
338348
* @default false
339349
*/

0 commit comments

Comments
 (0)