Skip to content

feat: Add real-time search functionality with dynamic results#143

Open
bipulsikder wants to merge 1 commit intoeclipse-sw360:mainfrom
bipulsikder:feat/search-implementation
Open

feat: Add real-time search functionality with dynamic results#143
bipulsikder wants to merge 1 commit intoeclipse-sw360:mainfrom
bipulsikder:feat/search-implementation

Conversation

@bipulsikder
Copy link
Contributor

Proposed Solution
Implement a real-time search feature that allows users to quickly find relevant documentation content.

check the demo Video also from here

Image Image

then redirect to the clicked suggestion
Image

Features:

  • Dynamic search with real-time results
  • Search through page titles, categories, and content summaries
  • Relevance-based result ranking
  • Result highlighting for matched terms
  • Keyboard shortcuts (press '/' to focus search)
  • Mobile-responsive design

Technical Implementation:

  • Used Hugo's built-in .Site.Pages for generating the search index
  • Implemented client-side search using JavaScript
  • Added relevance scoring algorithm
  • Debounced search for better performance
  • Maximum 10 results shown for optimal UX

UI/UX Considerations:

  • Dark theme compatible
  • Accessible (proper ARIA labels)
  • Keyboard navigation support
  • Clear visual feedback for interactions
  • Mobile-friendly design

Files Changed:

  • Added: layouts/_default/search.json

  • Added: layouts/partials/search.html

  • Modified: layouts/partials/navbar.html

  • Modified: package-lock.json

    check the demo Video also from here

@bipulsikder
Copy link
Contributor Author

Please let me know your thoughts upon this @heliocastro @GMishx @KoukiHama

@KoukiHama
Copy link
Member

KoukiHama commented Apr 6, 2025

Please agree eca for PR.
https://www.eclipse.org/legal/eca/

@bipulsikder
Copy link
Contributor Author

Please agree eca for PR. https://www.eclipse.org/legal/eca/

Yes I have agreed the eca @KoukiHama

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

Successfully merging this pull request may close these issues.

2 participants