feat(LineGauge): allow LineGauge background styles

[nowNick]

Description

LineGauge can be styled with regard to the line itself. There was no option to style the background behind the line. There was a community issue request to add such a feature.

This PR deprecates gauge_style in favor of filled_style and unfilled_style which can have it's foreground and background styled.

Demo

cargo run --example=line_gauge --features=crossterm

Demo

line_gauge_demo.mov

Issue link

Implements ratatui-org#424

[Fabus1184]

Very nice, I too think the name gauge_background_style is still confusing because of the word "background" which does not clearly indicate that this refers to the "unfilled" area of the gauge, it would be better to have LineGauge::filled_style and LineGauge::unfilled_style or some similar term. IMO because of compatibility LineGauge::gauge_style can be left and just sets the Style::fg field of the LineGauge::filled_style and the Style::bg field of the LineGauge::unfilled_style so it won't alter the behavior.

[nowNick]

Oh I like that! We can mark LineGauge::gauge_style as deprecated and introduce LineGauge::filled_style and LineGauge::unfilled_style with proper fg and bg. Then in future we can remove LineGauge::gauge_style

[TieWay59]

LineGauge::filled_style is neat. I'm always confused by the bg/fg somehow, I favor this wording.

And saw your screenshot above, it's great. Hope the new API design did not slow you down, it is always hard to give backward compatibility.

[joshka]

Another +1 to filled / unfilled from me.

The remaining tasks on this are something like:

• Fix the end of line spacing in doc comments (replace with multiple new lines to break the paragraphs)
• Update to use filled_style and unfilled_style
• Mark gauge style as deprecated with a message to use filled and unfilled
• Write / update tests
• Create a small demo and VHS tape file

[github-actions]

Thank you for opening this pull request!

We require commits to be signed and it looks like this PR contains unsigned commits.

Get help in the CONTRIBUTING.md
or on Github doc.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.3%. Comparing base (257db62) to head (33d8c40).

Additional details and impacted files

@@          Coverage Diff          @@
##            main    #565   +/-   ##
=====================================
  Coverage   94.3%   94.3%           
=====================================
  Files         61      61           
  Lines      14767   14777   +10     
=====================================
+ Hits       13926   13937   +11     
+ Misses       841     840    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[nowNick]

Hey all! :)

It took me some time but finally I got around to wrapping everything up. I tried to check all of the boxes on the todo list you provided @joshka

[x] Fix the end of line spacing in doc comments (replace with multiple new lines to break the paragraphs)
[x] Update to use filled_style and unfilled_style
[x] Mark gauge style as deprecated with a message to use filled and unfilled
[x] Write / update tests
[x] Create a small demo and VHS tape file

---

I'm not 100% if vhs demo will be recorded on the main branch in the repository itself or should I do it from my computer and somehow upload it?
Also I couldn't quite run the vhs tape file according to the instructions in the comments.
They all say something like:

# To run this script, install vhs and run `vhs ./examples/paragraph.tape`

and I don't think that the path is quite right. Shouldn't it be vhs ./examples/vhs/paragraph.tape ?

[joshka]

ugh - Figured I'd try hitting the "Sync Changes" button in VSCode to let it push things - that was a mistake! What a useless button.

[nowNick]

So happy it got merged! 🎉
Thanks for everybody's help! Especially @joshka for pushing it over the last hump 🙇