textbox 0.5.0

An elegant utility for slotting text/images into named slots in templates.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

# `textbox`

An elegant utility for constructing templates that can have text or images slotted into an existing layout.

---

## Overview

By initializing a `TextBox`, you can define a **template image** and place named components on it:

- **Text components** (`TextArea`) for rendering text
- **Image components** (`ImageArea`) for overlaying images

Once the template is defined, you can fill in content at runtime with a `TextBoxRender`, placing text and images in predictable slots.

---

## Quickstart

```rs
let mut template: DynamicImage = /* ... */;
let text_box = TextBox::new(template)
    .image_component("flag", ImageArea::new((0, 0)))
    .text_component("name", TextArea::new(
        (0, 200),
        400,
        BLACK,
        FontArc::try_from_slice(include_bytes!("path/to/font.ttf"))?,
        48.0,
        Align::Center
    ));

let flag: DynamicImage = /* ... */;

let render = TextBoxRender::new()
    .image("flag", flag)
    .text("name", "Germany");
let img = text_box.render(render)?;
```

--

## Design

`TextBox` is dependent on the `image`, `imageproc` and `ab_glyph` crates. The goal is to make it easy to create reusable containers for slotting images and text into predictable slots.

Text fields allow for a subset of markdown styles if the provided font is a _variable font_, like Roboto Flex. Bold, italic, and colored styles are usable. Colored styles use Markdown link syntax, i.e. `[Colored Text](#FF0000)`, since static images could never be clickable links anyway. If the font doesn't support those features, all styles will be ignored.