MiniWiki logoMiniWiki

SearchBar #

Search component for indexing and querying docs content.

Need custom card search?

Use PresetSearch for searching custom pre-defined result cards and metadata.

Props #

PropTypeRequiredDescription
documentsArray<{ title: string, excerpt: string, route: string }>YesSearch corpus.
placeholderstringNoInput placeholder text.

Live examples #

Code #

mdx
<SearchBar
	placeholder="Search docs examples..."
	documents={[
		{ title: 'Quickstart', excerpt: 'Install and run MiniWiki.', route: '/guides/quickstart' },
		{ title: 'JSON Reference', excerpt: 'All config keys.', route: '/guides/json-reference/index' },
	]}
/>

Notes #

  • Used by Header when search is enabled.
  • Placeholder defaults to Search docs....
Edit this page