#tui #ratatui #terminal #console #text-rendering #customization

tui-big-text

A simple Ratatui widget for displaying big text using the font8x8 crate in a TUI (Terminal UI)

18 unstable releases (3 breaking)

new 0.4.3 Apr 12, 2024
0.4.2 Feb 26, 2024
0.3.6 Feb 5, 2024
0.3.5 Jan 30, 2024
0.1.4 Sep 5, 2023

#188 in Command-line interface

Download history 44/week @ 2023-12-22 33/week @ 2023-12-29 24/week @ 2024-01-05 53/week @ 2024-01-12 52/week @ 2024-01-19 35/week @ 2024-01-26 85/week @ 2024-02-02 142/week @ 2024-02-09 250/week @ 2024-02-16 415/week @ 2024-02-23 154/week @ 2024-03-01 84/week @ 2024-03-08 91/week @ 2024-03-15 51/week @ 2024-03-22 105/week @ 2024-03-29 15/week @ 2024-04-05

269 downloads per month
Used in 4 crates

MIT/Apache

74KB
1K SLoC

tui-big-text

tui-big-text is a rust crate that renders large pixel text as a Ratatui widget using the glyphs from the font8x8 crate.

Demo

Crate badge Docs.rs Badge Deps.rs Badge
License Badge Codecov.io Badge Discord Badge

GitHub Repository · API Docs · Examples · Changelog · Contributing

Installation

cargo add ratatui tui-big-text

Usage

Create a BigText widget using BigText::builder and pass it to render_widget to render be rendered. The builder allows you to customize the Style of the widget and the PixelSize of the glyphs.

Examples

use anyhow::Result;
use ratatui::prelude::*;
use tui_big_text::{BigText, PixelSize};

fn render(frame: &mut Frame) -> Result<()> {
    let big_text = BigText::builder()
        .pixel_size(PixelSize::Full)
        .style(Style::new().blue())
        .lines(vec![
            "Hello".red().into(),
            "World".white().into(),
            "~~~~~".into(),
        ])
        .build()?;
    frame.render_widget(big_text, frame.size());
    Ok(())
}

The PixelSize can be used to control how many character cells are used to represent a single pixel of the 8x8 font. It has six variants:

  • Full (default) - Each pixel is represented by a single character cell.
  • HalfHeight - Each pixel is represented by half the height of a character cell.
  • HalfWidth - Each pixel is represented by half the width of a character cell.
  • Quadrant - Each pixel is represented by a quarter of a character cell.
  • ThirdHeight - Each pixel is represented by a third of the height of a character cell.
  • Sextant - Each pixel is represented by a sixth of a character cell.
BigText::builder().pixel_size(PixelSize::Full);
BigText::builder().pixel_size(PixelSize::HalfHeight);
BigText::builder().pixel_size(PixelSize::Quadrant);

Pixel Size

Text can be aligned to the Left / Right / Center using the alignment method.

use ratatui::layout::Alignment;
BigText::builder().alignment(Alignment::Left);
BigText::builder().alignment(Alignment::Right);
BigText::builder().alignment(Alignment::Center);

Alignment Example

License

Copyright (c) 2023 Josh McKinney

This project is licensed under either of

at your option.

Contribution

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

See CONTRIBUTING.md.

Dependencies

~6–13MB
~127K SLoC