search

CloudCannon / pagefind

Static low-bandwidth search at scale
https://pagefind.app
MIT License
3.24k stars 99 forks source link

Docs: `resultTemplate` UI config option is missing #511

Closed ttntm closed 7 months ago

ttntm commented 7 months ago

It seems like https://github.com/CloudCannon/pagefind/blob/971186cdd062995c14d2cc2bc711b09c850d086f/pagefind_ui/modular/components/resultList.js#L31 is missing from the docs.

I would expect it to be included somewhere in the "References" section, more specifically in Pagefind UI configuration options.

bglw commented 7 months ago

👋 Hey @ttntm 🙂

For now, everything under the modular directory is in flux — it's currently documented at https://www.npmjs.com/package/@pagefind/modular-ui.

The documentation on pagefind.app only covers the "Default UI" — which does not have a resultTemplate option available.

Hope that helps explain things! The API surface of the Modular UI is likely to change before being locked in and released, hence the delay in sharing that configuration. It's on the (near) roadmap 🙂

ttntm commented 7 months ago

Hi @bglw 👋

Thanks for answering that question so quickly. I understand and it makes sense.

I would not have found it if it wasn't for some article out there though. It's not a game changer, but it does indeed offer a little more flexibility in the implementation compared to "just" styling the default UI.