embedded-text

TextBox for embedded-graphics.

This crate provides a configurable TextBox to render multiline text inside a bounding Rectangle using [embedded-graphics].

TextBox supports the common text alignments: - Horizontal: - LeftAligned - RightAligned - CenterAligned - Justified - Vertical: - TopAligned - CenterAligned - BottomAligned - Scrolling

TextBox also supports some special characters not handled by embedded-graphics' Text: - non-breaking space (\u{200b}) - zero-width space (\u{a0}) - soft hyphen (\u{ad}) - carriage return (\r) - tab (\t) with configurable tab size

TextBox also supports text coloring using ANSI escape codes.

Example

The examples are based on [the embedded-graphics simulator]. The simulator is built on top of SDL2. See the [simulator README] for more information.

```rust use embeddedgraphics::{ fonts::Font6x8, pixelcolor::BinaryColor, prelude::*, primitives::Rectangle, }; use embeddedgraphicssimulator::{ BinaryColorTheme, OutputSettingsBuilder, SimulatorDisplay, Window, }; use embeddedtext::prelude::*;

fn main() { let text = "Hello, World!\n\ Lorem Ipsum is simply dummy text of the printing and typesetting industry. \ Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when \ an unknown printer took a galley of type and scrambled it to make a type specimen book.";

// Specify the styling options:
// * Use the 6x8 font from embedded-graphics.
// * Draw the text horizontally left aligned (default option, not specified here).
// * Use `FitToText` height mode to stretch the text box to the exact height of the text.
// * Draw the text with `BinaryColor::On`, which will be displayed as light blue.
let textbox_style = TextBoxStyleBuilder::new(Font6x8)
    .text_color(BinaryColor::On)
    .height_mode(FitToText)
    .build();

// Specify the bounding box. Note the 0px height. The `FitToText` height mode will
// measure and adjust the height of the text box in `into_styled()`.
let bounds = Rectangle::new(Point::zero(), Point::new(128, 0));

// Create the text box and apply styling options.
let text_box = TextBox::new(text, bounds).into_styled(textbox_style);

// Create a simulated display with the dimensions of the text box.
let mut display = SimulatorDisplay::new(text_box.size());

// Draw the text box.
text_box.draw(&mut display).unwrap();

// Set up the window and show the display's contents.
let output_settings = OutputSettingsBuilder::new()
    .theme(BinaryColorTheme::OledBlue)
    .build();
Window::new("Left aligned TextBox example", &output_settings).show_static(&display);

} ```

Development setup

Minimum supported Rust version

The minimum supported Rust version for embedded-text is 1.41.0 or greater. Ensure you have the latest stable version of Rust installed, preferably through https://rustup.rs.

Installation

For setup in general, follow the installation instructions for [embedded-graphics].

To install SDL2 on Windows, see https://github.com/Rust-SDL2/rust-sdl2#windows-msvc

Attribution

The example text is copied from https://www.lipsum.com