Struct TerminalProps 

pub struct TerminalProps {
    pub output: ReadSignal<Vec<TermLine>>,
    pub label: Option<AccessibleName>,
    pub state: TermState,
    pub prompt: String,
    pub session: Option<String>,
    pub exit: Option<i32>,
    pub cursor: CursorStyle,
    pub onsubmit: Option<EventHandler<String>>,
    pub class: Option<String>,
    pub attributes: Vec<Attribute>,
}

Properties for the Terminal component.

Fields

output: ReadSignal<Vec<TermLine>>

label: Option<AccessibleName>

Names the output region; “Terminal output” when omitted.

state: TermState

prompt: String

The prompt drawn before the input.

session: Option<String>

The shell or session name at the start of the status bar.

exit: Option<i32>

The last command’s exit code; zero is success.

cursor: CursorStyle

onsubmit: Option<EventHandler<String>>

class: Option<String>

attributes: Vec<Attribute>

Implementations

impl TerminalProps

pub fn builder() -> TerminalPropsBuilder<((), (), (), (), (), (), (), (), (), ())>

Create a builder for building TerminalProps. On the builder, call .output(...), .label(...)(optional), .state(...)(optional), .prompt(...)(optional), .session(...)(optional), .exit(...)(optional), .cursor(...)(optional), .onsubmit(...)(optional), .class(...)(optional), .attributes(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of TerminalProps.

Trait Implementations

impl Clone for TerminalProps

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialEq for TerminalProps

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Properties for TerminalProps

where Self: Clone,

type Builder = TerminalPropsBuilder<((), (), (), (), (), (), (), (), (), ())>

The type of the builder for this component. Used to create “in-progress” versions of the props.

fn builder() -> Self::Builder

Create a builder for this component.

fn memoize(&mut self, new: &Self) -> bool

Make the old props equal to the new props. Return if the props were equal and should be memoized.

fn into_vcomponent<M>( self, render_fn: impl ComponentFunction<Self, M>, ) -> VComponent

where M: 'static,

Create a component from the props.