Struct TextArea

pub struct TextArea<'a> { /* private fields */ }

Text area widget.

Backend used is ropey, so large texts are no problem. Editing time increases with the number of styles applied. Everything below a million styles should be fine.

For emoji support this uses unicode_display_width which helps with those double-width emojis. Input of emojis strongly depends on the terminal. It may or may not work. And even with display there are sometimes strange glitches that I haven’t found yet.

Keyboard and mouse are implemented for crossterm, but it should be easy to extend to other event-types. Every interaction is available as function on the state.

Scrolling doesn’t depend on the cursor, but the editing and move functions take care that the cursor stays visible.

Wordwrap is not available. For display only use Paragraph, as for editing: why?

You can directly access the underlying Rope for readonly purposes, and conversion from/to byte/char positions are available. That should probably be enough to write a parser that generates some styling.

The cursor must set externally on the ratatui Frame as usual. screen_cursor gives you the correct value. There is the inverse too set_screen_cursor For more interactions you can use screen_to_col, and try_col_to_screen. They calculate everything, even in the presence of more complex graphemes and those double-width emojis.

Implementations

impl<'a> TextArea<'a>

pub fn new() -> Self

New widget.

pub fn styles_opt(self, styles: Option<TextStyle>) -> Self

Set the combined style.

pub fn styles(self, style: TextStyle) -> Self

Set the combined style.

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

Base style.

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

Style when focused.

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

Selection style.

pub fn text_style<T: IntoIterator<Item = Style>>(self, styles: T) -> Self

List of text-styles.

Use TextAreaState::add_style() to refer a text range to one of these styles.

pub fn block(self, block: Block<'a>) -> Self

Block.

pub fn scroll(self, scroll: Scroll<'a>) -> Self

Set both scrollbars.

pub fn hscroll(self, scroll: Scroll<'a>) -> Self

Set the horizontal scrollbar.

pub fn set_horizontal_max_offset(self, offset: usize) -> Self

Set a maximum horizontal offset that will be used even if there is no horizontal scrollbar set.

This widget doesn’t try to find a maximum text-length for all lines.

Default is 255

pub fn set_horizontal_overscroll(self, overscroll: usize) -> Self

Set a horizontal overscroll that will be used even if there is no horizontal scrollbar set.

Default is 16384

pub fn vscroll(self, scroll: Scroll<'a>) -> Self

Set the vertical scrollbar.

Trait Implementations

impl<'a> Clone for TextArea<'a>

fn clone(&self) -> TextArea<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TextArea<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for TextArea<'a>

fn default() -> TextArea<'a>

Returns the “default value” for a type.

impl<'a> StatefulWidget for TextArea<'a>

type State = TextAreaState

State associated with the stateful widget.

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.