Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/lume/plugins/pagefind.ts>UIOptions

🔥 Static site generator for Deno 🦕
Very Popular
Go to Latest
interface UIOptions
import { type UIOptions } from "https://deno.land/x/lume@v1.17.2/plugins/pagefind.ts";

Properties

containerId: string

The container id to insert the search

showImages: boolean

Whether to show an image alongside each search result.

showEmptyFilters: boolean

By default, Pagefind UI shows filters with no results alongside the count (0). Pass false to hide filters that have no remaining results.

resetStyles: boolean

By default, Pagefind UI applies a CSS reset to itself. Pass false to omit this and inherit from your site styles.

optional
translations: TranslationsOptions

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.

optional
processTerm: (term: string) => string

A function that Pagefind UI calls before performing a search. This can be used to normalize search terms to match your content.