pub struct Terminal<A = ()> { /* private fields */ }Expand description
Interactive view of a live [TerminalState].
The state signal is both read and updated for local/external resize results.
Without an input callback the widget is read-only and unhandled navigation
keys scroll it. With a callback, keyboard, paste, and enabled terminal mouse
tracking produce protocol bytes. Ctrl+Shift+C/V are reserved for clipboard;
Shift+Page/Home/End always scrolls locally. Scrollbar track and thumb
interactions are handled locally before terminal mouse reporting and never
emit protocol bytes. With mouse tracking enabled, an unmodified wheel remains
terminal input, while Shift keeps its existing local-history bypass.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::Terminal;
let state = State::new(TerminalState::new());
let terminal: Terminal<()> = Terminal::new(state).follow_output(true);
let _ = terminal;Implementations§
Source§impl<A: 'static> Terminal<A>
impl<A: 'static> Terminal<A>
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_widgets::layout::Container;
let widget: Container<()> = Container::new().height(40.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_widgets::layout::Container;
let widget: Container<()> = Container::new().min_width(40.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_widgets::layout::Container;
let widget: Container<()> = Container::new().max_width(320.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_widgets::layout::Container;
let widget: Container<()> = Container::new().min_height(24.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_widgets::layout::Container;
let widget: Container<()> = Container::new().max_height(240.0);
let _ = widget;Sourcepub fn fill(self) -> Self
pub fn fill(self) -> Self
Sets both preferred axes to parent fill.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().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_widgets::layout::Container;
let widget: Container<()> = Container::new().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_widgets::layout::Container;
let widget: Container<()> = Container::new().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_widgets::layout::Container;
let widget: Container<()> = Container::new().margin(8.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_widgets::layout::Container;
let widget: Container<()> = Container::new().padding(8.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_widgets::layout::Container;
let widget: Container<()> = Container::new().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_widgets::layout::Container;
let widget: Container<()> = Container::new().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_widgets::layout::Container;
let widget: Container<()> = Container::new().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_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_basis(80.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;
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().align_self(AlignItems::Center);
let _ = widget;Source§impl<A: 'static> Terminal<A>
impl<A: 'static> Terminal<A>
Sourcepub fn new(state: impl Into<Signal<TerminalState>>) -> Self
pub fn new(state: impl Into<Signal<TerminalState>>) -> Self
Creates a focused-capable terminal from a writable state signal.
It defaults to 760 by 280 logical pixels, follows output, auto-resizes local state, shows scrollbars, and has no input/synchronization callbacks.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::Terminal;
let terminal: Terminal<()> = Terminal::new(State::new(TerminalState::new()));
let _ = terminal;Sourcepub fn terminal_style(self, style: TerminalWidgetStyle) -> Self
pub fn terminal_style(self, style: TerminalWidgetStyle) -> Self
Replaces visual style and resets layout width/height to its intrinsic size.
Call layout builders after this method to override those dimensions.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::{Terminal, TerminalWidgetStyle};
let terminal: Terminal<()> = Terminal::new(State::new(TerminalState::new()))
.terminal_style(TerminalWidgetStyle::default())
.width(900.0);
let _ = terminal;Sourcepub fn initial_scroll_y(self, scroll_y: f32) -> Self
pub fn initial_scroll_y(self, scroll_y: f32) -> Self
Sets initial vertical scroll offset in logical pixels.
Negative values and NaN become zero. Positive infinity is retained and subsequently clamps to the bottom during viewport synchronization.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::Terminal;
let terminal: Terminal<()> = Terminal::new(State::new(TerminalState::new()))
.initial_scroll_y(120.0);
let _ = terminal;Sourcepub fn selection(self, selection: TerminalSelection) -> Self
pub fn selection(self, selection: TerminalSelection) -> Self
Sets the initial selection in visual-line/cell coordinates.
Line indices are clamped to available visual lines during paint; column endpoints are clamped independently for each extracted/highlighted line.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::{Terminal, TerminalPosition, TerminalSelection};
let selection = TerminalSelection::new(
TerminalPosition::new(0, 0),
TerminalPosition::new(0, 4),
);
let terminal: Terminal<()> = Terminal::new(State::new(TerminalState::new())).selection(selection);
let _ = terminal;Sourcepub fn selection_mode(self, mode: TerminalSelectionMode) -> Self
pub fn selection_mode(self, mode: TerminalSelectionMode) -> Self
Sets initial retained selection-mode metadata.
Pointer clicks subsequently replace it according to click count.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::{Terminal, TerminalSelectionMode};
let terminal: Terminal<()> = Terminal::new(State::new(TerminalState::new()))
.selection_mode(TerminalSelectionMode::Word);
let _ = terminal;Sourcepub fn follow_output(self, follow_output: bool) -> Self
pub fn follow_output(self, follow_output: bool) -> Self
Sets whether line-count changes keep the viewport at the bottom.
User scrolling turns follow mode off when farther than one cell height from the bottom and on again within that threshold.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::Terminal;
let terminal: Terminal<()> = Terminal::new(State::new(TerminalState::new())).follow_output(false);
let _ = terminal;Sourcepub fn jump_bottom(self) -> Self
pub fn jump_bottom(self) -> Self
Requests an initial bottom scroll and enables output following.
This uses f32::MAX as a sentinel that is clamped to the actual maximum.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::Terminal;
let terminal: Terminal<()> = Terminal::new(State::new(TerminalState::new())).jump_bottom();
let _ = terminal;Sourcepub fn auto_resize(self, auto_resize: bool) -> Self
pub fn auto_resize(self, auto_resize: bool) -> Self
Enables or disables local terminal-grid resizing.
Geometry/resize callbacks take precedence regardless of this flag. The
default is true.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::Terminal;
let terminal: Terminal<()> = Terminal::new(State::new(TerminalState::new())).auto_resize(false);
let _ = terminal;Sourcepub fn scrollbars(self, scrollbars: bool) -> Self
pub fn scrollbars(self, scrollbars: bool) -> Self
Shows/reserves or hides/releases the interactive vertical scrollbar.
Scrolling remains available when hidden. The default is true.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::Terminal;
let terminal: Terminal<()> = Terminal::new(State::new(TerminalState::new())).scrollbars(false);
let _ = terminal;Sourcepub fn on_input(self, f: impl Fn(Vec<u8>) -> A + 'static) -> Self
pub fn on_input(self, f: impl Fn(Vec<u8>) -> A + 'static) -> Self
Maps each encoded terminal input byte vector to an application action.
Keyboard input, bracketed paste, and enabled mouse-tracking reports share this callback. A later input builder replaces it.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::Terminal;
#[derive(Clone)]
enum Action { Input(Vec<u8>) }
let terminal = Terminal::new(State::new(TerminalState::new())).on_input(Action::Input);
let _ = terminal;Sourcepub fn on_input_ctx(
self,
f: impl Fn(&mut EventCtx<A>, Vec<u8>) + 'static,
) -> Self
pub fn on_input_ctx( self, f: impl Fn(&mut EventCtx<A>, Vec<u8>) + 'static, ) -> Self
Installs a context-aware encoded-input handler.
A later input builder replaces it.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::Terminal;
let terminal = Terminal::<()>::new(State::new(TerminalState::new()))
.on_input_ctx(|_ctx, bytes| assert!(!bytes.is_empty()));
let _ = terminal;Sourcepub fn sync_state_from(
self,
f: impl Fn() -> Option<TerminalState> + 'static,
) -> Self
pub fn sync_state_from( self, f: impl Fn() -> Option<TerminalState> + 'static, ) -> Self
Installs a state poll invoked during authoritative layout and event handling.
Some(state) replaces the signal only when different; None leaves it
unchanged. A layout poll is staged and becomes visible only after that
authoritative layout commits; paint never polls or mutates terminal state.
The callback should be fast and non-blocking.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::Terminal;
let terminal: Terminal<()> = Terminal::new(State::new(TerminalState::new()))
.sync_state_from(|| None);
let _ = terminal;Sourcepub fn sync_resize_to(
self,
f: impl Fn(TerminalViewportSize) -> Option<TerminalState> + 'static,
) -> Self
pub fn sync_resize_to( self, f: impl Fn(TerminalViewportSize) -> Option<TerminalState> + 'static, ) -> Self
Installs a compact resize callback.
It runs after committed geometry or state-grid changes when no geometry
callback is installed. Returning Some replaces differing state;
returning None supports side-effect-only PTY resize requests.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::Terminal;
let terminal: Terminal<()> = Terminal::new(State::new(TerminalState::new()))
.sync_resize_to(|viewport| { assert!(viewport.terminal.cols >= 1); None });
let _ = terminal;Sourcepub fn sync_geometry_to(
self,
f: impl Fn(TerminalGeometry) -> Option<TerminalState> + 'static,
) -> Self
pub fn sync_geometry_to( self, f: impl Fn(TerminalGeometry) -> Option<TerminalState> + 'static, ) -> Self
Installs the highest-priority measured-geometry callback.
It receives 32-bit rounded content extents, cell metrics, and grid size
after committed geometry or state-grid changes. Some replaces differing
state; None supports side-effect-only synchronization.
§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_terminal_core::TerminalState;
use ailloli_ui_widgets::controls::Terminal;
let terminal: Terminal<()> = Terminal::new(State::new(TerminalState::new()))
.sync_geometry_to(|geometry| { assert!(geometry.cols >= 1); None });
let _ = terminal;