import { type UIOptions } from "https://deno.land/x/lume@v2.2.4/plugins/pagefind.ts";
Properties
The number of search results to load at once, before a “Load more” button is shown.
The maximum number of characters to show in the excerpt.
0 means no limit
A function that Pagefind UI calls before performing a search. This can be used to normalize search terms to match your content.
A function that Pagefind UI calls before displaying each result. This can be used to fix relative URLs, rewrite titles, or any other modifications you might like to make to the raw result object returned by Pagefind
By default, Pagefind UI shows filters with no results alongside the count (0). Pass false to hide filters that have no remaining results.
The default behavior of the filter display is to show values only when there is one filter with six or fewer values. When you include a filter name in openFilters it will open by default, regardless of the number of filters or values present.
By default, Pagefind UI applies a CSS reset to itself. Pass false to omit this and inherit from your site styles.
The number of milliseconds to wait after a user stops typing before performing a search. If you wish to disable this, set to 0.
A set of custom ui strings to use instead of the automatically detected language strings. See https://github.com/CloudCannon/pagefind/blob/main/pagefind_ui/translations/en.json for all available keys and initial values. The items in square brackets such as SEARCH_TERM will be substituted dynamically when the text is used.
Enabling autofocus automatically directs attention to the search input field for enhanced user convenience, particularly beneficial when the UI is loaded within a modal dialog. However, exercise caution, as using autofocus indiscriminately may pose potential accessibility challenges.
Passes sort options to Pagefind for ranking. Note that using a sort will override all ranking by relevance.