Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 2.05 KB

7.search-content.md

File metadata and controls

37 lines (26 loc) · 2.05 KB
Raw

searchContent()

Used to search in your content directory.

const input = ref('')
const results = searchContent(input)

Parameters

Key Type Default Description
search MaybeRefOrGetter<string> The search input
options SearchContentOptions {} The options
options.miniSearch MaybeRefOrGetter<MiniSearchOptions<T>> The options passed to miniSearch
options.fetch MaybeRefOrGetter<UseFetchOptions<string | T>> The options passed to useFetch

MiniSearchOptions

You can easily define the miniSearch options by using the defineMiniSearchOptions composable:

const miniSearchOptions = defineMiniSearchOptions({
  fields: ['title', 'description', 'body']
})

Using these options allows you to modify how the search is performed. You can change the fields that are searched, the weight of each field, and more.

::alert{type="info"} Only available when using the simple search, aka non-indexed search. ::

UseFetchOptions

An option is provided to customize the behavior of the useFetch composable used internally to only fetch the search content on client and lazy. This could avoid fetching the content on SSR and adding content to the _payload.json file improving the performance of your app since _payload is loaded for hydration.