feat(search): allow enabling detailed view by default

closes #2690
pull/2723/head
Divyansh Singh 2 years ago
parent 1179484432
commit 4af597582c

@ -104,13 +104,15 @@ const filterText = disableQueryPersistence.value
const showDetailedList = useLocalStorage( const showDetailedList = useLocalStorage(
'vitepress:local-search-detailed-list', 'vitepress:local-search-detailed-list',
false theme.value.search?.provider === 'local' &&
theme.value.search.options?.detailedView === true
) )
const disableDetailedView = computed(() => { const disableDetailedView = computed(() => {
return ( return (
theme.value.search?.provider === 'local' && theme.value.search?.provider === 'local' &&
theme.value.search.options?.disableDetailedView === true (theme.value.search.options?.disableDetailedView === true ||
theme.value.search.options?.detailedView === false)
) )
}) })

@ -331,9 +331,19 @@ export namespace DefaultTheme {
export interface LocalSearchOptions { export interface LocalSearchOptions {
/** /**
* @default false * @default false
* @deprecated Use `detailedView: false` instead.
*/ */
disableDetailedView?: boolean 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 * @default false
*/ */

Loading…
Cancel
Save