Support conversion from `String` to `Color` about ratatui HOT 14 CLOSED

I would like to give it a try :)

from ratatui.

I don't think it needs to be behind a feature:

• Converting from a string based on the variant name is very common, and with the to_lower call to make it case-insensitive, it covers any capitalization preferences. (this is also how the fairly widely used strum crate does it).

• having a constructor Color::parse_rbg(&str) -> Result<Self, ParseError> that just handles the most common case of #abcdef and doesn't use the Rgb crate as a dependency. This probably covers most TUI cases - I don't expect people to need color conversions or alternate representation (and if they do, they can source the Rgb crate for themselves).

from ratatui.

If it's not to hard without regex, no dependency is the preference.

from ratatui.

This might be a "good first issue" too (unless you're planning on knocking it out yourself)

from ratatui.

Oh yeah, I was waiting for some comments, but sure. Anyone should be free to pick it up 🐻

from ratatui.

Go for it!

from ratatui.

@orhun

In the example, I used rgb crate for converting HEX values to Color as well. Since it introduces a new dependency, I'm not sure if we should do that as well.

what would be the ideal solution for you ?

from ratatui.

New dep ain't cool. I'm not sure how TrueColor conversion would work without it though. I haven't thought about it in depth.

But if you ask me I would blindly go with that solution. I simply created this issue to get more comments about it.

from ratatui.

I wouldn't use strings if I have enums. Enums are more maintainable. If someone wants easy string to enum conversation, that'd be a separate feature flag, with someone dedicated to maintain it.

from ratatui.

I wouldn't use strings if I have enums. Enums are more maintainable.

The reason why I want this feature is because you need this conversion from the outside of ratatui, for example when you have a configuration file which have a color field and you need to implement De/Serialize for it. In that case, you either going to define your own color enum in your project and manually convert it to ratatui::style::Color OR you will have a string which will somehow support this conversion. I usually go with the latter approach since it has the advantage of true color support. When we use strings, the color can simply be hex code (#000) instead of a name (black) as well.

from ratatui.

That's the thing... Some may prefer "red", for some it's "RED", while some may prefer hex. There's no "right" conversion system to use. The current serde implementation converts it to "Red", which I think is a good enough default.

EDIT: consider both to and from string.

EDIT 2: Ah... I see now, one good usecase of this would be to allow conversion from all these different conversion systems into the enum. That might be useful in the sense that the users can choose the style they prefer. But one (probably minor) drawback of this is that, when converting back to string (ser), we have to default to one of the systems. So, if a user writes it as "RED", and when viewing the config (serialized version) sees "Red" or hex code, they'll be pretty confused.

from ratatui.

I think, we can add it as an optional feature and see how many people use it. This way, we don't have to worry about the dependency issue.

from ratatui.

I agree with @sophacles 💯

from ratatui.

is it okay to use regex or should we go with no additional depency at all ?

from ratatui.