Struct TerminalBuilder 

pub struct TerminalBuilder { /* private fields */ }

Builder for Terminal views.

Implementations

impl TerminalBuilder

pub fn new() -> Self

pub fn handle(self, handle: TerminalHandle) -> Self

Set the terminal handle (required).

Get a handle from cx.use_terminal() in your component.

Examples found in repository

examples/33_terminal.rs (line 20)

fn app(cx: Scope) -> View {
    let terminal = terminal!(cx);

    // Spawn bash on first render
    if !terminal.is_started() {
        if let Err(e) = terminal.spawn("bash", &[], 80, 24) {
            eprintln!("Failed to spawn terminal: {}", e);
        }
    }

    View::vstack()
        .child(View::text("Telex Terminal Demo"))
        .child(View::text(
            "Press Ctrl+Shift+[ to escape terminal focus, Tab to navigate",
        ))
        .child(View::terminal().handle(terminal).build())
        .build()
}

pub fn rows(self, rows: usize) -> Self

Set the number of visible rows (default: 24).

pub fn cols(self, cols: usize) -> Self

Set the number of visible columns (default: 80).

pub fn border(self, border: bool) -> Self

Enable or disable border (default: true).

pub fn title(self, title: impl Into<String>) -> Self

Set the border title (default: “Terminal”).

pub fn on_exit(self, callback: impl Fn() + 'static) -> Self

Set a callback to be invoked when the PTY process exits.

pub fn build(self) -> View

Examples found in repository

examples/33_terminal.rs (line 20)

fn app(cx: Scope) -> View {
    let terminal = terminal!(cx);

    // Spawn bash on first render
    if !terminal.is_started() {
        if let Err(e) = terminal.spawn("bash", &[], 80, 24) {
            eprintln!("Failed to spawn terminal: {}", e);
        }
    }

    View::vstack()
        .child(View::text("Telex Terminal Demo"))
        .child(View::text(
            "Press Ctrl+Shift+[ to escape terminal focus, Tab to navigate",
        ))
        .child(View::terminal().handle(terminal).build())
        .build()
}

Trait Implementations

impl Default for TerminalBuilder

fn default() -> Self

Returns the “default value” for a type.