kimono

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 41)

A terminal style toolkit inspired by CSS for elegant TUIs :kimono:

kimono Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# kimono

A terminal style toolkit inspired by CSS and [lipgloss](https://github.com/charmbracelet/lipgloss) for [truecolor 24-bit terminals](https://github.com/termstandard/colors#terminal-emulators).  Made for elegant TUIs.

Image terminal rendering done by our sister project [ukiyeo](https://github.com/richardanaya/ukiyoe/).

```terminal
cargo add kimono
```
# Examples

*Text can be styled.*

```rust
use kimono::*;

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

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

*Unicode text can be padded, bordered, and positioned.*

```rust
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.*

```rust
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.*

```terminal
(8, 5)
```

```rust
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.*

```rust
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.*

```rust
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.

![1658677463667](https://user-images.githubusercontent.com/294042/180660263-281711c1-d29d-48f2-bee4-32b8f0658fd7.jpeg)

![1658677463603](https://user-images.githubusercontent.com/294042/180660265-1a82172d-1b89-4ab6-b653-b496f2396b24.jpeg)

![1658677461856](https://user-images.githubusercontent.com/294042/180660271-d5085b4d-bd4e-463c-acb5-5ed425b92403.jpeg)

# License

This project is licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
   http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](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.

kimono

kimono Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

kimono

kimono Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README