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

[Feature] Implement and Enhance Search Functionality with Debounce and Highlight Matching Terms #130

Open
wendy640 opened this issue Oct 7, 2024 · 1 comment
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing feature 🟩 priority: low Low priority and doesn't need to be rushed 🚧 status: blocked Blocked & therefore, not ready for work

Comments

@wendy640
Copy link

wendy640 commented Oct 7, 2024

Problem

The project did not originally have any search functionality for filtering posts based on user input. Users cannot easily find relevant content within the posts. This lack of search limits usability, especially as the number of posts grows.

Description

This feature will implement a search bar to filter posts based on user input. The search should:

  • Filter posts based on matching the title or content.

  • Display "No matching results" if no posts match the query.

  • Enhance performance by debouncing the search function, preventing unnecessary searches on each keystroke.

  • Highlight the matching search terms within posts to improve visibility and usability.

  • Reset the post list to its original state when the search query is cleared.

Alternatives

  1. Basic Filtering without Debounce
  2. Advanced Filters

Implementation

  • Implement post filtering based on user input.

  • Add a debounce mechanism to delay search execution until the user finishes typing.

  • Implement highlighting of matching search terms within the post content.

  • Ensure that when the search input is cleared, the original post list is restored.

  • I would be interested in implementing this feature.

Screen Shot 2024-10-07 at 9 30 53 PM

@wendy640 wendy640 added ✨ goal: improvement Improvement to an existing feature 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🟩 priority: low Low priority and doesn't need to be rushed labels Oct 7, 2024
@possumbilities possumbilities added 🚧 status: blocked Blocked & therefore, not ready for work and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Oct 7, 2024
@possumbilities
Copy link
Contributor

Vocabulary functions as a Design system with static prototype specimens for reference, an implementation like this would be something done in the dynamic layer of a project and seems outside the scope of what Vocabulary's functionality would provide.

Moving to 🚧 status: blocked Blocked & therefore, not ready for work since there is a possibility for exploring this further down the road, at least from a UX angle, even if the behavior isn't facillitated within Vocabulary itself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing feature 🟩 priority: low Low priority and doesn't need to be rushed 🚧 status: blocked Blocked & therefore, not ready for work
Projects
Status: Backlog
Development

No branches or pull requests

2 participants