Struct rat_widget::textarea::RTextArea

pub struct RTextArea<'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 trivial 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 from_screen_col, and to_screen_col. They calculate everything, even in the presence of more complex graphemes and those double-width emojis.

Implementations

impl<'a> RTextArea<'a>

pub fn new() -> Self

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

Set the combined style.

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

Base text style.

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

Style when focused.

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

Style for selection

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

List of text-styles.

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

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

Trait Implementations

impl<'a> Clone for RTextArea<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RTextArea<'a>

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

Formats the value using the given formatter.

impl<'a> Default for RTextArea<'a>

fn default() -> RTextArea<'a>

Returns the “default value” for a type.

impl<'a> ScrollingWidget<RTextAreaState> for RTextArea<'a>

fn need_scroll(&self, area: Rect, state: &mut RTextAreaState) -> (bool, bool)

Widget wants a (horizontal, vertical) scrollbar. This gets combined with the ScrollbarPolicy.

impl<'a> StatefulWidget for RTextArea<'a>

type State = RTextAreaState

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.

impl<'a> StatefulWidgetRef for RTextArea<'a>

type State = RTextAreaState

State associated with the stateful widget.

fn render_ref(&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.