rusty_style

Crates.iorusty_style
lib.rsrusty_style
version0.1.2
sourcesrc
created_at2023-05-18 01:58:52.247209
updated_at2023-05-18 21:03:25.744904
descriptionRusty Style is a library for styling text in the terminal.
homepage
repository
max_upload_size
id867356
size13,613
Edward Elton (edwardelton)

documentation

README

Rusty Style


gloss
Download Download Build Status


Introduction

  • Rusty Style is a Terminal Utility to style your TUI project.
  • It is mainly inspired by lipgloss, a golang TUI library.

Rusty style is built on the builder design pattern. Designing your TUI is easier than ever with Rusty Style.


Example

For a simple demo, take a look into the examples directory.

use rusty_style::{Color, Style};

fn main() {
    let underline = Style::new().underline();

    println!("{}", underline.render("I am underline!"));

    let bold = Style::new().bold();

    println!("{}", bold.render("I am bold!"));

    let my_style = Style::new()
        .bold()
        .italic()
        .foreground(Color::new(255, 192, 203))
        .set_string("I have multiple");

    println!("{}", my_style.render(", Styles!")); // render will append the text to I Have multiple
}

Example


Color

Rusty Style supports True Color:

RGB

rusty_style::Color::new(255, 192, 203) // pink
rusty_style::Color::new(166, 200, 148) // green
rusty_style::Color::new(142, 29, 206) // purple

HEX

rusty_style::Color::convert_hex_to_rgb("#DE3163").unwrap() // cerse
rusty_style::Color::convert_hex_to_rgb("#9F2B68").unwrap() // amaranth
rusty_style::Color::convert_hex_to_rgb("#F2D2BD").unwrap() // bisque

Inline Formatting

Rusty Style supports the usual ANSI text formatting options:

let style = rusty_style::Style::new()
    bold().
    faint().
    italic().
    underline().
    blink().
    reverse().
    invisible().
    strikethrough();

Tips

When using render, you will lose ownership of your style because render is made to be used once you are done with your style. If you want to keep your style object we recommend you to clone your style.

let style = rusty_style::Style::new();

let my_copy = style.clone();

Warning

  • If you have any suggestions, problems, open a problem (if it is an error, you must be sure to look if you can solve it with Google!)

Support me

  • Thanks for looking at this repository, if you like to press the ⭐ button!
  • Made by Edward Elton.

Informations
GitHub Repo stars GitHub top language GitHub last commit GitHub GitHub watchers

Commit count: 0

cargo fmt