zulip/zulip-terminal

Show search-key & prefix in search boxes if search is enabled

Open

#552 opened on Mar 21, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (352 forks)github user discovery
area: UIhelp wanted

Repository metrics

Stars
 (853 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We conveniently show the keys to jump to search boxes, and when typing text it should be clear that this is filtering the results, or maybe just after pressing 'enter', also hopefully obviously.

However, once the search is enabled, ie. the list of items are filtered, we should probably show the key at the end of the box again, though the actual search text of course will not include this key text. This makes it clear to users that they can go back to the search.

It would also be good to show that a search is 'in progress'/'enabled', by prefixing some text. This is similar to the approach taken in the message list when searching/filtering messages.

Contributor guide

Research direction
Inspect the search functionality in the UI code (e.g., FilteredListBox widget). Identify where the search key is displayed and how the search state is managed. Then modify the code to show the search key again and a prefix (like 'Search:') when the search is active.
Tech stack
python
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65