Struct Terminal

Source
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>

Source

pub fn width(self, value: impl Into<Length>) -> Self

Sets preferred width from a logical-pixel or length value.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().width(120.0);
let _ = widget;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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>

Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;

Trait Implementations§

Source§

impl<A: 'static> IntoView<A> for Terminal<A>

Source§

fn into_view(self) -> View<A>

Consumes a builder/value and returns its declarative view tree. Read more
Source§

impl<A: 'static> LayoutExt for Terminal<A>

Source§

fn layout_mut(&mut self) -> &mut LayoutStyle

Returns the widget’s mutable declarative size/inset state. Read more

Auto Trait Implementations§

§

impl<A> Freeze for Terminal<A>

§

impl<A = ()> !RefUnwindSafe for Terminal<A>

§

impl<A = ()> !Send for Terminal<A>

§

impl<A = ()> !Sync for Terminal<A>

§

impl<A> Unpin for Terminal<A>

§

impl<A = ()> !UnwindSafe for Terminal<A>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T, A> FlexItemExt<A> for T
where T: IntoView<A>,

Source§

fn flex_grow(self) -> View<A>

Sets flex-grow weight to one. Read more
Source§

fn flex_grow_by(self, value: f32) -> View<A>

Sets the dimensionless flex-grow weight. Read more
Source§

fn flex_shrink(self, value: f32) -> View<A>

Sets the dimensionless flex-shrink weight. Read more
Source§

fn flex_basis(self, value: impl Into<Length>) -> View<A>

Sets the preferred main-axis flex basis. Read more
Source§

fn align_self(self, value: AlignItems) -> View<A>

Overrides the parent cross-axis alignment for this view. Read more
Source§

fn fill_width(self) -> View<A>

Marks width as parent-fill in the view size hint. Read more
Source§

fn fill_height(self) -> View<A>

Marks height as parent-fill in the view size hint. Read more
Source§

fn fill(self) -> View<A>

Marks both axes as parent-fill in the view size hint. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T, A> IntoViewKeyExt<A> for T
where T: IntoView<A>,

§

fn key(self, key: impl Into<String>) -> View<A>

Converts self, assigns the owned key, and returns the view. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,