Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing documentation: Fuse.js #89

Open
damms005 opened this issue Aug 7, 2022 · 1 comment
Open

Missing documentation: Fuse.js #89

damms005 opened this issue Aug 7, 2022 · 1 comment

Comments

@damms005
Copy link

damms005 commented Aug 7, 2022

In README.md under How to define search synonyms, I believe it should be explicitly made clear the effect of the filteredItems() function using Fuse JS, to the end that the result returned from the Spotlight command on the backend may not be shown/displayed on the frontend because it is filtered out from what is displayed to the user, differently from what is returned by the backend.

I lost quality time trying to debug why I returned items as SpotlightSearchResult but nothing showed up on the frontend. I had to dive into the code to figure that out, and I believe such crucial behaviour should be documented.

Please let me know if a PR that updates the doc to this effect is welcomed.

@undjike
Copy link

undjike commented Jan 2, 2023

I faced the same issue.
I thought of disabling front filtering when the search engine is not command.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants