pub struct TerminalView { /* private fields */ }Expand description
Scrollable terminal-log widget with static lines and/or streaming events.
This is a log viewer, not a PTY or ANSI parser. It is always keyboard focusable; selection controls only pointer selection. The default history cap is 2,000 complete lines and matching is ASCII-case-insensitive. Its overlay scrollbar supports captured thumb dragging and centered track clicks; wheel, track, and drag all use the same bounded history offset.
§Examples
use ailloli_ui_widgets::controls::{TerminalLine, TerminalView};
let terminal = TerminalView::new().line(TerminalLine::success("finished"));
let _ = terminal;Implementations§
Source§impl TerminalView
impl TerminalView
Sourcepub fn width(self, value: impl Into<Length>) -> Self
pub fn width(self, value: impl Into<Length>) -> Self
Sets preferred width from a logical-pixel or length value.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).width(24.0);
let _ = widget;Sourcepub fn height(self, value: impl Into<Length>) -> Self
pub fn height(self, value: impl Into<Length>) -> Self
Sets preferred height from a logical-pixel or length value.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).height(24.0);
let _ = widget;Sourcepub fn min_width(self, value: impl Into<Length>) -> Self
pub fn min_width(self, value: impl Into<Length>) -> Self
Sets the minimum width bound.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).min_width(12.0);
let _ = widget;Sourcepub fn max_width(self, value: impl Into<Length>) -> Self
pub fn max_width(self, value: impl Into<Length>) -> Self
Sets the maximum width bound.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).max_width(32.0);
let _ = widget;Sourcepub fn min_height(self, value: impl Into<Length>) -> Self
pub fn min_height(self, value: impl Into<Length>) -> Self
Sets the minimum height bound.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).min_height(12.0);
let _ = widget;Sourcepub fn max_height(self, value: impl Into<Length>) -> Self
pub fn max_height(self, value: impl Into<Length>) -> Self
Sets the maximum height bound.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).max_height(32.0);
let _ = widget;Sourcepub fn fill(self) -> Self
pub fn fill(self) -> Self
Sets both preferred axes to parent fill.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill();
let _ = widget;Sourcepub fn fill_width(self) -> Self
pub fn fill_width(self) -> Self
Sets preferred width to parent fill.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill_width();
let _ = widget;Sourcepub fn fill_height(self) -> Self
pub fn fill_height(self) -> Self
Sets preferred height to parent fill.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill_height();
let _ = widget;Sourcepub fn margin(self, value: f32) -> Self
pub fn margin(self, value: f32) -> Self
Sets uniform outer margin in logical pixels.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).margin(4.0);
let _ = widget;Sourcepub fn padding(self, value: f32) -> Self
pub fn padding(self, value: f32) -> Self
Sets uniform inner padding in logical pixels.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).padding(4.0);
let _ = widget;Sourcepub fn flex_grow(self) -> Self
pub fn flex_grow(self) -> Self
Sets flex-grow weight to one.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_grow();
let _ = widget;Sourcepub fn flex_grow_by(self, value: f32) -> Self
pub fn flex_grow_by(self, value: f32) -> Self
Sets a dimensionless flex-grow weight.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_grow_by(2.0);
let _ = widget;Sourcepub fn flex_shrink(self, value: f32) -> Self
pub fn flex_shrink(self, value: f32) -> Self
Sets a dimensionless flex-shrink weight.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_shrink(1.0);
let _ = widget;Sourcepub fn flex_basis(self, value: impl Into<Length>) -> Self
pub fn flex_basis(self, value: impl Into<Length>) -> Self
Sets the preferred main-axis flex basis.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_basis(20.0);
let _ = widget;Sourcepub fn align_self(self, value: AlignItems) -> Self
pub fn align_self(self, value: AlignItems) -> Self
Overrides cross-axis alignment for this flex item.
§Examples
use ailloli_ui_core::{style::AlignItems, IconId};
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).align_self(AlignItems::Center);
let _ = widget;Source§impl TerminalView
impl TerminalView
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates an empty terminal with default style and interaction settings.
The initial size is 680 x 260 logical pixels, cursor/selection/scrollbar
behavior is enabled, and vertical scroll starts at zero.
§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new();
let _ = terminal;Sourcepub fn line(self, line: TerminalLine) -> Self
pub fn line(self, line: TerminalLine) -> Self
Appends one initial complete line.
§Examples
use ailloli_ui_widgets::controls::{TerminalLine, TerminalView};
let terminal = TerminalView::new().line(TerminalLine::prompt("$ "));
let _ = terminal;Sourcepub fn lines(self, lines: impl IntoIterator<Item = TerminalLine>) -> Self
pub fn lines(self, lines: impl IntoIterator<Item = TerminalLine>) -> Self
Extends initial complete lines in iterator order.
Existing lines are preserved and the history cap is applied during build.
§Examples
use ailloli_ui_widgets::controls::{TerminalLine, TerminalView};
let terminal = TerminalView::new().lines([TerminalLine::new("one"), TerminalLine::new("two")]);
let _ = terminal;Sourcepub fn event(self, event: TerminalEvent) -> Self
pub fn event(self, event: TerminalEvent) -> Self
Appends one initial event to apply after initial lines.
§Examples
use ailloli_ui_widgets::controls::{TerminalEvent, TerminalView};
let terminal = TerminalView::new().event(TerminalEvent::stdout_chunk(1, "building"));
let _ = terminal;Sourcepub fn events(self, events: impl IntoIterator<Item = TerminalEvent>) -> Self
pub fn events(self, events: impl IntoIterator<Item = TerminalEvent>) -> Self
Extends initial events in iterator order without sorting by sequence.
§Examples
use ailloli_ui_widgets::controls::{TerminalEvent, TerminalView};
let terminal = TerminalView::new().events([TerminalEvent::clear(1), TerminalEvent::status(2, "ready")]);
let _ = terminal;Sourcepub fn event_source(self, source: Rc<dyn TerminalEventSource>) -> Self
pub fn event_source(self, source: Rc<dyn TerminalEventSource>) -> Self
Installs a pull source, replacing any previous source.
It is synchronously drained during layout, paint, and input; sources should therefore return promptly and avoid blocking UI work.
§Examples
use std::rc::Rc;
use ailloli_ui_widgets::controls::{TerminalEventBuffer, TerminalView};
let terminal = TerminalView::new().event_source(Rc::new(TerminalEventBuffer::new()));
let _ = terminal;Sourcepub fn event_buffer(self, buffer: TerminalEventBuffer) -> Self
pub fn event_buffer(self, buffer: TerminalEventBuffer) -> Self
Installs a cloneable shared FIFO event buffer as the source.
Keep a clone before moving the buffer when later producers need to push.
§Examples
use ailloli_ui_widgets::controls::{TerminalEventBuffer, TerminalView};
let writer = TerminalEventBuffer::new();
let terminal = TerminalView::new().event_buffer(writer.clone());
let _ = terminal;Sourcepub fn max_history(self, max_history: usize) -> Self
pub fn max_history(self, max_history: usize) -> Self
Sets the maximum number of retained complete lines.
Oldest complete lines are removed first. Zero rejects complete appended lines; an unfinished nonempty chunk may still be visible as the partial line.
§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().max_history(500);
let _ = terminal;Sourcepub fn search_query(self, query: impl Into<Binding<String>>) -> Self
pub fn search_query(self, query: impl Into<Binding<String>>) -> Self
Sets the static or reactive exact search query.
Empty queries produce no matches; whitespace is not trimmed.
§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().search_query("error".to_string());
let _ = terminal;Sourcepub fn search_case_sensitive(self, case_sensitive: bool) -> Self
pub fn search_case_sensitive(self, case_sensitive: bool) -> Self
Selects exact-case or ASCII-case-insensitive matching.
The default is false (ASCII-case-insensitive).
§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().search_case_sensitive(true);
let _ = terminal;Sourcepub fn selection(self, selection: TerminalSelection) -> Self
pub fn selection(self, selection: TerminalSelection) -> Self
Sets the initial selection; line bounds are clamped during build/paint.
The selection still paints when pointer selection is disabled.
§Examples
use ailloli_ui_widgets::controls::{TerminalSelection, TerminalView};
let terminal = TerminalView::new().selection(TerminalSelection::lines(0, 2));
let _ = terminal;Sourcepub fn terminal_style(self, style: TerminalViewStyle) -> Self
pub fn terminal_style(self, style: TerminalViewStyle) -> Self
Replaces style and resets explicit layout width/height to its defaults.
Call width/height builders after this method to override the style sizes.
§Examples
use ailloli_ui_widgets::controls::{TerminalView, TerminalViewStyle};
let terminal = TerminalView::new().terminal_style(TerminalViewStyle::default());
let _ = terminal;Sourcepub fn initial_scroll_y(self, scroll_y: f32) -> Self
pub fn initial_scroll_y(self, scroll_y: f32) -> Self
Sets requested initial vertical scroll offset in logical pixels.
f32::max normalizes negative values and NaN to zero; positive infinity
is retained until scroll metrics clamp it during layout.
§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().initial_scroll_y(120.0);
let _ = terminal;Sourcepub fn show_cursor(self, show_cursor: bool) -> Self
pub fn show_cursor(self, show_cursor: bool) -> Self
Enables or disables cursor painting; enabled by default.
§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().show_cursor(false);
let _ = terminal;Sourcepub fn cursor_line(self, cursor_line: usize) -> Self
pub fn cursor_line(self, cursor_line: usize) -> Self
Sets the zero-based line after which the cursor is painted.
Without this call the last buffer line is used. An out-of-range index paints no cursor.
§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().cursor_line(3);
let _ = terminal;Sourcepub fn selectable(self, selectable: bool) -> Self
pub fn selectable(self, selectable: bool) -> Self
Enables or disables pointer-drag selection updates.
This does not change focusability, keyboard scrolling, or a supplied
initial selection. The default is true.
§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().selectable(false);
let _ = terminal;Sourcepub fn scrollbars(self, scrollbars: bool) -> Self
pub fn scrollbars(self, scrollbars: bool) -> Self
Enables scrollbar reservation, painting, and pointer interaction. This is enabled by default.
Scrolling remains available when this is false.
§Examples
use ailloli_ui_widgets::controls::TerminalView;
let terminal = TerminalView::new().scrollbars(false);
let _ = terminal;