kimono

A terminal style toolkit inspired by CSS and lipgloss for truecolor 24-bit terminals. Made for elegant TUIs.

Image terminal rendering done by our sister project ukiyeo.

cargo add kimono

Examples

Text can be styled.

use kimono::*;

const STYLE: Style = Style::new().bold().color(0x91b984);

fn main() {
    STYLE.render("こんにちは");
}

Unicode text can be padded, bordered, and positioned.

use kimono::*;

const STYLE: Style = Style::new()
    .padding_top(1)
    .padding_left(1)
    .padding_right(2)
    .padding_bottom(3)
    .border(1)
    .border_style(BORDER_STYLE_OUTLINE)
    .border_color(0xddae74)
    .border_background(0xbc5633)
    .color(0xebdeb8)
    .background(0x407955);

fn main() {
    clear_screen();
    STYLE.render_at_position(10, 3, "着物");
    print!("\n\r");
}

Text can be constrained to width and/or height.

use kimono::*;

const STYLE: Style = Style::new()
    .padding(1)
    .color(0xfffd7c)
    .width(8)
    .background(0x956471);

fn main() {
    clear_screen();
    STYLE.render_at_position(10, 3, "abcdefghijklmno");
    print!("\n\r");
}

Text can be measured.

(8, 5)

use kimono::*;

const STYLE: Style = Style::new()
    .padding(1)
    .color(0xfffd7c)
    .width(8)
    .background(0x956471);

fn main() {
    println!("{:?}", STYLE.measure("abcdefghijklmno"));
}

Borders have advanced styling.

use kimono::*;

const STYLE: Style = Style::new()
    .padding(1)
    .color(0xe46281)
    .background(0xc50f47)
    .border(1)
    .italic()
    .border_style(BorderStyle {
        top_left: None,
        top: Some('•'),
        top_right: None,
        left: Some('•'),
        right: Some('•'),
        bottom_left: None,
        bottom: Some('•'),
        bottom_right: None,
        bold: true,
        italic: false,
        underline: false,
        strikethrough: false,
    })
    .border_color(0xe5c7c9)
    .border_background(0x9e1d49);

fn main() {
    clear_screen();
    STYLE.render_at_position(10, 3, "The Tale of Genji by 紫 式部");
    print!("\n\r");
}

Text can be aligned.

use kimono::*;

const STYLE: Style = Style::new()
    .padding(1)
    .color(0xb1a49a)
    .background(0xea664d)
    .border(1)
    .width(30)
    .text_align(TextAlign::Center);

fn main() {
    clear_screen();
    STYLE.render_at_position(10, 3, "sun egg mango");
    print!("\n\r");
}

Art

Kimono patterns inspired from Unix terminals.

License

This project is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in kimono by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.