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

Search improvements #81

Open
juuso-vaadin opened this issue Jan 17, 2025 · 1 comment
Open

Search improvements #81

juuso-vaadin opened this issue Jan 17, 2025 · 1 comment
Labels
bug Something isn't working

Comments

@juuso-vaadin
Copy link

juuso-vaadin commented Jan 17, 2025

Issues

Search is triggered too eagerly

Typing in G (delay) RID will trigger the search after entering the first letter.
Search isn't triggered again before the first query is finished which results the UI and URL not being in sync with the displayed data.
This can be fixed by running the search again or refreshing the page. Typing in the field should immediately terminate any ongoing queries and start a new one. Eagerness could be tweaked to bit more delayed.

vaadin-directory-search.mov

Improvement ideas

Returning the results is annoyingly slow

Best fix would be to make the search query faster.

Secondary improvement could be to make the waiting time more bearable by introducing better loading state. The loading bar at the top doesn't appear associated with the contents of the web page. Skeleton loaders would make the experience more jumpy and also function as indicator for loading the data.

Image

Results are not prioritized by relevance

There could be some rough scoring based on if match is found in component title or description.
Components could also have metadata for core components they expand. For example searching for "vaadin-grid" would ideally return any components that add features to Vaadin Grid component.

Empty view when nothing is found

There should be a dedicated "Nothing found" message that ideally helps the user make better search queries.
Currently the toolbar number of matches doesn't update resulting the UI and data being out of sync.
Image

More advanced improvements could offer user with way of recovering. Check for misspelling of keywords, ask to check if other filters (Version selection) is active or suggest list of common searches.

@samie samie added the bug Something isn't working label Jan 20, 2025
samie added a commit that referenced this issue Jan 21, 2025
samie added a commit that referenced this issue Feb 18, 2025
@samie
Copy link
Member

samie commented Mar 19, 2025

We did some optimization for search, and while it still could be faster it should be better already. I'm keeping this issue open as discussion about further search improvements.

Notable changes:

  • search only after 3 or more letters are entered
  • client-side caching
  • serverside query caching

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants