Struct BigText 

#[non_exhaustive]
pub struct BigText<'a> {
    pub lines: Vec<Line<'a>>,
    pub style: Style,
    pub pixel_size: PixelSize,
    pub alignment: Alignment,
}

Displays one or more lines of text using 8x8 pixel characters.

The text is rendered using the font8x8 crate.

Using the pixel_size method, you can also chose, how ‘big’ a pixel should be. Currently a pixel of the 8x8 font can be represented by one full or half (horizontal/vertical/both) character cell of the terminal.

Examples

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

BigText::builder()
    .pixel_size(PixelSize::Full)
    .style(Style::new().white())
    .lines(vec![
        "Hello".red().into(),
        "World".blue().into(),
        "=====".into(),
    ])
    .build();

Renders:

██  ██           ███     ███
██  ██            ██      ██
██  ██   ████     ██      ██     ████
██████  ██  ██    ██      ██    ██  ██
██  ██  ██████    ██      ██    ██  ██
██  ██  ██        ██      ██    ██  ██
██  ██   ████    ████    ████    ████

██   ██                  ███       ███
██   ██                   ██        ██
██   ██  ████   ██ ███    ██        ██
██ █ ██ ██  ██   ███ ██   ██     █████
███████ ██  ██   ██  ██   ██    ██  ██
███ ███ ██  ██   ██       ██    ██  ██
██   ██  ████   ████     ████    ███ ██

 ███ ██  ███ ██  ███ ██  ███ ██  ███ ██
██ ███  ██ ███  ██ ███  ██ ███  ██ ███

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

lines: Vec<Line<'a>>

The text to display

style: Style

The style of the widget

Defaults to Style::default()

pixel_size: PixelSize

The size of single glyphs

Defaults to PixelSize::default() (=> PixelSize::Full)

alignment: Alignment

The horizontal alignment of the text

Defaults to Alignment::default() (=> Alignment::Left)

Implementations

impl BigText<'static>

pub fn builder() -> BigTextBuilder<'static>

Create a new BigTextBuilder to configure a BigText widget.

Trait Implementations

impl<'a> Clone for BigText<'a>

fn clone(&self) -> BigText<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for BigText<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Hash for BigText<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for BigText<'a>

fn eq(&self, other: &BigText<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Widget for BigText<'_>

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.

impl<'a> Eq for BigText<'a>

impl<'a> StructuralPartialEq for BigText<'a>