Struct TextBlock

Source

pub struct TextBlock { /* private fields */ }

Expand description

A multi-line text widget with wrapping support.

TextBlock is intentionally a pure renderer:

It does not own scroll state.
Scrolling/clipping should be implemented by drawing into a WindowView with scroll offsets (or by using ScrollBox / Viewport + ScrollState).

Implementations§

Source §

impl TextBlock

Source

pub fn new(width: u16, height: u16, text: impl Into<String>) -> Self

Creates a new TextBlock with the given size and content.

Examples found in repository ?

examples/widget_usage.rs (lines 113-120)

41fn create_app_layout(term_w: u16, term_h: u16) -> Container {
42    // `ContainerPadding` is what the prelude exports (the underlying type is `Padding`).
43    use minui::widgets::ContainerPadding;
44
45    // A simple "fill the terminal" root. Children will be laid out inside it.
46    // We make it vertical with a row gap so sections are visually separated.
47    let root = Container::new()
48        .with_position_and_size(0, 0, term_w, term_h)
49        .with_layout_direction(LayoutDirection::Vertical)
50        .with_row_gap(Gap::Pixels(1))
51        .with_padding(ContainerPadding::uniform(1));
52
53    // Header: fixed height so it behaves like an app bar.
54    let header_h: u16 = 3;
55    let header = Container::new()
56        .with_position_and_size(0, 0, term_w.saturating_sub(2), header_h)
57        .with_layout_direction(LayoutDirection::Vertical)
58        .with_border()
59        .with_border_chars(BorderChars::double_line())
60        .with_border_color(ColorPair::new(Color::LightBlue, Color::Black))
61        .with_title("MinUI Widget Demo")
62        .with_title_alignment(TitleAlignment::Center)
63        .with_padding(ContainerPadding::symmetric(0, 1))
64        .add_child(Label::new("Press 'q' to quit").with_text_color(Color::Cyan));
65
66    // Footer: also fixed height.
67    let footer_h: u16 = 3;
68    let footer = Container::new()
69        .with_position_and_size(0, 0, term_w.saturating_sub(2), footer_h)
70        .with_layout_direction(LayoutDirection::Vertical)
71        .with_border()
72        .with_border_chars(BorderChars::single_line())
73        .with_border_color(ColorPair::new(Color::Yellow, Color::Black))
74        .with_padding(ContainerPadding::symmetric(0, 1))
75        .add_child(Label::new("Status: Ready • Press 'q' to quit").with_text_color(Color::Yellow));
76
77    // Body: fills the remaining space (best-effort). We size it explicitly so content has a
78    // stable viewport, but rely on Container layout for its children.
79    let body_h = term_h
80        .saturating_sub(1) // root padding top
81        .saturating_sub(1) // root padding bottom
82        .saturating_sub(header_h)
83        .saturating_sub(1) // root row gap between header/body
84        .saturating_sub(footer_h)
85        .saturating_sub(1); // root row gap between body/footer
86
87    let body = Container::new()
88        .with_position_and_size(0, 0, term_w.saturating_sub(2), body_h)
89        .with_layout_direction(LayoutDirection::Horizontal)
90        .with_column_gap(Gap::Pixels(2))
91        .with_padding(ContainerPadding::uniform(0));
92
93    // Panels are auto-sized from children, then clipped by the body container viewport.
94    // The text blocks have explicit sizes so word wrapping behaves predictably.
95    let panel_w = (term_w.saturating_sub(2))
96         .saturating_sub(2) // body column gap
97         / 2;
98    let panel_h = body_h;
99
100    // Leave space for: borders (2) + padding (2) => content width/height roughly -4.
101    let text_w = panel_w.saturating_sub(4).max(1);
102    let text_h = panel_h.saturating_sub(4).max(1);
103
104    let left_panel = Container::new()
105        .with_position_and_size(0, 0, panel_w, panel_h)
106        .with_layout_direction(LayoutDirection::Vertical)
107        .with_border()
108        .with_border_chars(BorderChars::single_line())
109        .with_border_color(ColorPair::new(Color::Red, Color::Black))
110        .with_title("Left")
111        .with_padding(ContainerPadding::uniform(1))
112        .add_child(
113            TextBlock::new(
114                text_w,
115                text_h,
116                "This demonstrates how Containers can be arranged side-by-side. \
117 They support borders, titles, padding, and child layout. \
118 Resize the terminal to see how clipping behaves.\
119 \r\rThis is a hard carriage returned line.",
120            )
121            .with_word_wrap(),
122        );
123
124    let right_panel = Container::new()
125        .with_position_and_size(0, 0, panel_w, panel_h)
126        .with_layout_direction(LayoutDirection::Vertical)
127        .with_border()
128        .with_border_chars(BorderChars::single_line())
129        .with_border_color(ColorPair::new(Color::Green, Color::Black))
130        .with_title("Right")
131        .with_padding(ContainerPadding::uniform(1))
132        .add_child(
133            TextBlock::new(
134                text_w,
135                text_h,
136                "Multiple widgets can coexist inside Container layouts. \
137 Each Container manages styling, while children provide content. \
138 This text is wrapped using TextBlock.",
139            )
140            .with_word_wrap(),
141        );
142
143    let body = body.add_child(left_panel).add_child(right_panel);
144
145    root.add_child(header).add_child(body).add_child(footer)
146}

Source

pub fn auto_sized(text: impl Into<String>) -> Self

Creates a TextBlock that sizes itself to fit the content

Source

pub fn auto_sized_with_word_wrap( text: impl Into<String>, max_width: u16, ) -> Self

Creates a TextBlock with word wrapping that sizes itself to fit.

Wraps text at word boundaries, then sizes the widget to fit the wrapped content.

Source

pub fn with_colors(self, colors: ColorPair) -> Self

Sets the text colors

Source

pub fn with_text_color(self, color: Color) -> Self

Sets just the text color

Source

pub fn with_wrap_mode(self, mode: TextWrapMode) -> Self

Sets how text should wrap

Source

pub fn with_word_wrap(self) -> Self

Enables word wrapping

Examples found in repository ?

examples/widget_usage.rs (line 121)

41fn create_app_layout(term_w: u16, term_h: u16) -> Container {
42    // `ContainerPadding` is what the prelude exports (the underlying type is `Padding`).
43    use minui::widgets::ContainerPadding;
44
45    // A simple "fill the terminal" root. Children will be laid out inside it.
46    // We make it vertical with a row gap so sections are visually separated.
47    let root = Container::new()
48        .with_position_and_size(0, 0, term_w, term_h)
49        .with_layout_direction(LayoutDirection::Vertical)
50        .with_row_gap(Gap::Pixels(1))
51        .with_padding(ContainerPadding::uniform(1));
52
53    // Header: fixed height so it behaves like an app bar.
54    let header_h: u16 = 3;
55    let header = Container::new()
56        .with_position_and_size(0, 0, term_w.saturating_sub(2), header_h)
57        .with_layout_direction(LayoutDirection::Vertical)
58        .with_border()
59        .with_border_chars(BorderChars::double_line())
60        .with_border_color(ColorPair::new(Color::LightBlue, Color::Black))
61        .with_title("MinUI Widget Demo")
62        .with_title_alignment(TitleAlignment::Center)
63        .with_padding(ContainerPadding::symmetric(0, 1))
64        .add_child(Label::new("Press 'q' to quit").with_text_color(Color::Cyan));
65
66    // Footer: also fixed height.
67    let footer_h: u16 = 3;
68    let footer = Container::new()
69        .with_position_and_size(0, 0, term_w.saturating_sub(2), footer_h)
70        .with_layout_direction(LayoutDirection::Vertical)
71        .with_border()
72        .with_border_chars(BorderChars::single_line())
73        .with_border_color(ColorPair::new(Color::Yellow, Color::Black))
74        .with_padding(ContainerPadding::symmetric(0, 1))
75        .add_child(Label::new("Status: Ready • Press 'q' to quit").with_text_color(Color::Yellow));
76
77    // Body: fills the remaining space (best-effort). We size it explicitly so content has a
78    // stable viewport, but rely on Container layout for its children.
79    let body_h = term_h
80        .saturating_sub(1) // root padding top
81        .saturating_sub(1) // root padding bottom
82        .saturating_sub(header_h)
83        .saturating_sub(1) // root row gap between header/body
84        .saturating_sub(footer_h)
85        .saturating_sub(1); // root row gap between body/footer
86
87    let body = Container::new()
88        .with_position_and_size(0, 0, term_w.saturating_sub(2), body_h)
89        .with_layout_direction(LayoutDirection::Horizontal)
90        .with_column_gap(Gap::Pixels(2))
91        .with_padding(ContainerPadding::uniform(0));
92
93    // Panels are auto-sized from children, then clipped by the body container viewport.
94    // The text blocks have explicit sizes so word wrapping behaves predictably.
95    let panel_w = (term_w.saturating_sub(2))
96         .saturating_sub(2) // body column gap
97         / 2;
98    let panel_h = body_h;
99
100    // Leave space for: borders (2) + padding (2) => content width/height roughly -4.
101    let text_w = panel_w.saturating_sub(4).max(1);
102    let text_h = panel_h.saturating_sub(4).max(1);
103
104    let left_panel = Container::new()
105        .with_position_and_size(0, 0, panel_w, panel_h)
106        .with_layout_direction(LayoutDirection::Vertical)
107        .with_border()
108        .with_border_chars(BorderChars::single_line())
109        .with_border_color(ColorPair::new(Color::Red, Color::Black))
110        .with_title("Left")
111        .with_padding(ContainerPadding::uniform(1))
112        .add_child(
113            TextBlock::new(
114                text_w,
115                text_h,
116                "This demonstrates how Containers can be arranged side-by-side. \
117 They support borders, titles, padding, and child layout. \
118 Resize the terminal to see how clipping behaves.\
119 \r\rThis is a hard carriage returned line.",
120            )
121            .with_word_wrap(),
122        );
123
124    let right_panel = Container::new()
125        .with_position_and_size(0, 0, panel_w, panel_h)
126        .with_layout_direction(LayoutDirection::Vertical)
127        .with_border()
128        .with_border_chars(BorderChars::single_line())
129        .with_border_color(ColorPair::new(Color::Green, Color::Black))
130        .with_title("Right")
131        .with_padding(ContainerPadding::uniform(1))
132        .add_child(
133            TextBlock::new(
134                text_w,
135                text_h,
136                "Multiple widgets can coexist inside Container layouts. \
137 Each Container manages styling, while children provide content. \
138 This text is wrapped using TextBlock.",
139            )
140            .with_word_wrap(),
141        );
142
143    let body = body.add_child(left_panel).add_child(right_panel);
144
145    root.add_child(header).add_child(body).add_child(footer)
146}