Crate tui_big_text

source ·
Expand description

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.
Pixel Size Example

Pixel Size

Structs§

Enums§