Struct Options

pub struct Options {
    pub prompt: Option<String>,
    pub element: TargetElement,
    pub disable_clipboard_handling: bool,
    pub font_family: Option<String>,
    pub font_size: Option<f64>,
    pub scrollback: Option<u32>,
}

Terminal options

Fields

prompt: Option<String>

Default prompt (string such as "$ ")

element: TargetElement

Target DOM element (when running under WASM)

disable_clipboard_handling: bool

Disable internal clipboard handling (useful when using clipboard API calls externally)

font_family: Option<String>

Default font family (xterm.js only)

font_size: Option<f64>

Default font size (xterm.js only)

scrollback: Option<u32>

Default scrollback limit (xterm.js only)

Implementations

impl Options

pub fn new() -> Options

Create new default options

pub fn with_prompt(self, prompt: &str) -> Self

Set prompt string

pub fn with_scrollback(self, scrollback: u32) -> Self

Set scrollback limit

pub fn with_element(self, element: TargetElement) -> Self

Set target element

pub fn prompt(&self) -> String

Get prompt string

Trait Implementations

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.