TypeScript definitions for PagefindUI

CloudCannon / pagefind

Static low-bandwidth search at scale

https://pagefind.app

MIT License

3.63k stars 119 forks source link

TypeScript definitions for PagefindUI #334

Open shishkin opened 1 year ago

shishkin commented 1 year ago

Hi @bglw! Thanks again for publishing the UI as NPM package.

While building the astro integration for pagefind, I'd like to support all the props that the PagefindUI component accepts. It would really help to have @pagefind/default-ui package to expose TypeScript definitions. Then I would not need to duplicate typings of all the props that I just pass through.

It will also help anyone using the UI package with TypeScript in general. What do you think?

bglw commented 1 year ago

Hey @shishkin 👋

This is definitely something I'm looking to do! I'll aim to get this out in the next big release 🙂

87xie commented 1 month ago

Hi everyone, thanks for the great work!

Are there any plans to provide an official type definition for the Pagefind search API, similar to vite-plugin-pagefind? It would help me integrate existing components 🙏🙏.