Add Rule widget

[rodrigogiraoserrao]

This issue concerns itself with adding a new widget to Textual.
The rule widget should be similar to HTML rules.
The key difference is that HTML only has a horizontal rule and Rule's orientation can be customised ("horizontal" or "vertical").

You will want to implement a method render that is responsible for returning the characters that make up the rule itself.
You may also look at _progress_bar.py::Bar.render and _progress_bar.py::Bar.render_indeterminate for some inspiration on how to implement “a line” that you can render.

I suggest you start by implementing a horizontal rule.
After it works well, think about creating a vertical rule as well and make it customisable via a parameter, e.g., Rule(orientation="horizontal") and Rule(orientation="vertical").

Take a look at #2333 to see what files need to be changed when you implement a new widget.
Then, don't be like me and also do the final step shown in #2399 to add your new widget to the widget gallery.

Good luck and have fun!

[scriptogre]

Working on it! 😎

[rodrigogiraoserrao]

Hey Chris, we exchanged a couple of messages in private but I'd like to reiterate my question: are you working on this at your own pace or are you dropping this?
I'm asking just so we can know whether we'll need to tackle this ourselves or not.

[rodrigogiraoserrao]

This is up for grabs.
See #3060 for a pretty good PR that is almost there.

[TomJGooding]

I'm not necessarily volunteering, but just to clarify do you think this is better separated into HorizontalRule and VerticalRule widgets, or stick to the original brief of just a single Rule widget with an orientation parameter?

[willmcgugan]

I have no strong opinion on that. Surprising, coming from me. 🤷‍♂️

[rodrigogiraoserrao]

How 'bout Rule(..., orientation=...) but then, like the Button variants, maybe provide Rule.horizontal() and Rule.vertical() class methods?

[TomJGooding]

Ugh, apparently my fork now has snapshot tests failing on main even if I did want to volunteer. Any suggestions?

[willmcgugan]

How 'bout Rule(..., orientation=...) but then, like the Button variants, maybe provide Rule.horizontal() and Rule.vertical() class methods?

Sounds like the best of both worlds

[willmcgugan]

Ugh, apparently my fork now has snapshot tests failing on main even if I did want to volunteer. Any suggestions?

We have a few flaky tests that are timing sensitive. They run lovely but occasionally fail in CI. You may find you can run them again and they will pass.

[rodrigogiraoserrao]

Ugh, apparently my fork now has snapshot tests failing on main even if I did want to volunteer. Any suggestions?

(Not sure what you are forking, but in case you are forking the PR that has some work on this already, do note that the OP had an issue in his code.)

[TomJGooding]

Sorry to clarify the tests are failing locally on the same fork I've had kicking around for a while. AFAIR everything was working fine recently, perhaps due to some changes with textual-dev...?

EDIT: All tests now passing after running poetry install, though not sure what changed to see failing tests! Sorry, blame my unfamiliarity with poetry...

[willmcgugan]

Ah. Probably the textual-dev dependency!

[github-actions]

Don't forget to star the repository!

Follow @textualizeio for Textual updates.