Struct tui_term::widget::Cursor

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());

Trait Implementations

impl Default for Cursor

fn default() -> Self

Returns the “default value” for a type.