zulip-terminal icon indicating copy to clipboard operation
zulip-terminal copied to clipboard

Add manual cycling of random hints in footer

Open Niloth-p opened this issue 1 year ago • 2 comments
trafficstars

What does this PR do, and why?

Enables cycling through random hints in the footer.

  • Using a hotkey to manually go to next hint
  • Periodically cycle through footer hints automatically

This is in preparation to #1484, where we add contexts and the footer displays only the context-specific hotkey hints.

Outstanding aspect(s)

  • If this is good, the next step could involve making the footer's cycle period a user setting.
  • Deciding the hotkey to go to next hint: I've currently used Tab, but that's subject to change on discussion.
  • Deciding the default cycle period: I've currently set it to 30 seconds, but we could increase it.

External discussion & connections

How did you test this?

  • [x] Manually - Behavioral changes
  • [ ] Manually - Visual changes
  • [ ] Adapting existing automated tests
  • [x] Adding automated tests for new behavior (or missing tests)
  • [ ] Existing automated tests should already cover this (only a refactor of tested code)

Self-review checklist for each commit

  • [x] It is a minimal coherent idea
  • [x] It has a commit summary following the documented style (title & body)
  • [ ] It has a commit summary describing the motivation and reasoning for the change
  • [x] It individually passes linting and tests
  • [x] It contains test additions for any new behavior
  • [x] It flows clearly from a previous branch commit, and/or prepares for the next commit

Niloth-p avatar Jun 13 '24 12:06 Niloth-p

Hello @zulip/server-hotkeys members, this pull request was labeled with the "area: hotkeys" label, so you may want to check it out!

zulipbot avatar Jun 13 '24 13:06 zulipbot

I left some notes in the channel, but getting the first commit merged with an adjusted key would be great as a first step. The remainder could be useful, particularly since refactoring to make it clearer to understand could benefit if we keep the timed approach, but could also depend on the style of help hints we settle on when they're more contextual.

neiljp avatar Jun 29 '24 06:06 neiljp

@Niloth-p Thanks for the quick PR adjust, which I only just noticed. The only change I made was to make it clearer that the 'hint' being referred to is an regard to a hotkey :)

neiljp avatar Jul 04 '24 22:07 neiljp