Struct tui_term::widget::Cursor

#[non_exhaustive]
pub struct Cursor { /* private fields */ }

Implementations

impl Cursor

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

Sets the symbol for the cursor.

Arguments

• symbol: The symbol to set as the cursor.

Example

use ratatui::style::Style;
use tui_term::widget::Cursor;

let cursor = Cursor::default().symbol("|");

pub const fn style(self, style: Style) -> Self

Sets the style for the cursor.

Arguments

• style: The Style to set for the cursor.

Example

use ratatui::style::Style;
use tui_term::widget::Cursor;

let cursor = Cursor::default().style(Style::default());

pub const fn overlay_style(self, overlay_style: Style) -> Self

Sets the overlay style for the cursor.

The overlay style is used when the cursor overlaps with existing content on the screen.

Arguments

• overlay_style: The Style to set as the overlay style for the cursor.

Example

use ratatui::style::Style;
use tui_term::widget::Cursor;

let cursor = Cursor::default().overlay_style(Style::default());

pub const fn visibility(self, show: bool) -> Self

Set the visibility of the cursor (default = shown)

Examples found in repository

examples/simple_ls_controller.rs (line 75)

fn ui(f: &mut Frame, screen: &Screen) {
    let chunks = ratatui::layout::Layout::default()
        .direction(ratatui::layout::Direction::Vertical)
        .margin(1)
        .constraints(
            [
                ratatui::layout::Constraint::Percentage(100),
                ratatui::layout::Constraint::Min(1),
            ]
            .as_ref(),
        )
        .split(f.size());
    let title = Line::from("[ Running: ls ]");
    let block = Block::default()
        .borders(Borders::ALL)
        .title(title)
        .style(Style::default().add_modifier(Modifier::BOLD));
    let pseudo_term = PseudoTerminal::new(screen)
        .cursor(tui_term::widget::Cursor::default().visibility(false))
        .block(block.clone());
    f.render_widget(pseudo_term, chunks[0]);
    let explanation = "Press q to exit";
    let explanation = Paragraph::new(explanation)
        .style(Style::default().add_modifier(Modifier::BOLD | Modifier::REVERSED))
        .alignment(Alignment::Center);
    f.render_widget(explanation, chunks[1]);
}

pub fn show(&mut self)

Show the cursor (default)

pub fn hide(&mut self)

Hide the cursor

Trait Implementations

impl Default for Cursor

fn default() -> Self

Returns the “default value” for a type.