Add hover actions #2868
Add hover actions #2868
Conversation
… motion events are enabled for other reasons
…ility with action tags
Codecov Report
@@ Coverage Diff @@
## master #2868 +/- ##
==========================================
- Coverage 13.17% 13.15% -0.02%
==========================================
Files 162 162
Lines 11509 11539 +30
==========================================
+ Hits 1516 1518 +2
- Misses 9993 10021 +28
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
There was a problem hiding this comment.
The code looks good. I very much prefer this solution to the original toggle implementation (even if it may sometimes be a bit more verbose for users). If there is a demand for it, we can just add a hover-toggle option which either just produces both hover-start and hover-end tags or is its own mouse "button" that just does both. The latter is probably preferable because it keeps it "mouse config option maps to a single action tag" property and it can be used when the hover-toggle option doesn't exist.
I'm interested in what kind of use cases you have found and played around with for this feature.
I have been playing around with the date module and it does look really nice:
label = %{A9:#date.toggle:}%{A10:#date.toggle:}%date%%{A9 A10}
No mouse hover:
Mouse hovering over date module:
It also makes for a very cool automatically opening and closing menu module:
format = %{A9:#menu.open: A10:#menu.close:}<label-toggle><menu>%{A9 A10}
Also, something to note is that when the bar content changes and the mouse is in a new hover region, the hover code is not triggered until the mouse moves again. I don't necessarily find this a limitation, I just wanted to point this out so we're all aware of it. It also has the nice side-effect of preventing the infinite repetition of the hover start action triggering a bar update, which changes the bar content, which triggers the hover end action, which changes the bar content back and starts the whole thing from the beginning again.
And congrats on your new job!! 🥳
| @@ -444,7 +448,7 @@ vector<exception_test> parse_error_test = { | |||
| {"%{O0ptx}", exc::OFFSET}, | |||
| {"%{O0a}", exc::OFFSET}, | |||
| {"%{A2:cmd:cmd:}", exc::TAG_END}, | |||
| {"%{A9}", exc::BTN}, | |||
| {"%{A11}", exc::BTN}, | |||
There was a problem hiding this comment.
Maybe actually use mousebtn::BTN_COUNT in this string directly so that we don't have to manually update it.
There was a problem hiding this comment.
Would this be a good way of doing it?
std::string invalid_mouse_btn = std::to_string(static_cast<int>(mousebtn::BTN_COUNT));
...
{"%{A" + invalid_mouse_btn + "}", exc::BTN},
|
Bump? |
I'm waiting for @patrick96 to get back to me on the requested changes 😅. If he approves of the way I want to implement what he asked for I can add those changes in an instant. |
|
@patrick96? Please approve I've been waiting for ages for this feature please please 😩 |
|
@patrick96 +1 |
|
Thanks a lot for this! I just yoinked it and I will extend this a little bit so more modules can have alternate version on hover 😁 👍 |
What type of PR is this? (check all applicable)
Description
Modules can now register actions to trigger when the mouse enters or leaves an area with two new
mousbtnentries:HOVER_STARTandHOVER_END.Script module now accepts
hover-start = ...andhover-end = ...commands.Bar config now accepts
disable-hover-checking = (true|false)setting to disable checking for hover. This also factors into whether the bar subscribes to mouse motion and mouse enter/leave events.Related Issues & Documents
Closes #1064
Documentation (check all applicable)
The Wiki documentation for the script module should include the two new
hover_startandhover_endactions. Also the formatting section on inline actions should update to say that action numbers9and10are now forhover startandhover end.The section on bar settings should also add the new
disable-hover-checkingkey and clarify that it's intended use is to improve performance if the user doesn't want actions.