Struct TextArea 

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

Text area widget.

Example

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.

Text wrapping is available, hard line-breaks at the right margin, or decent word-wrapping.

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_pos, and pos_to_screen. They calculate everything, even in the presence of more complex graphemes and those double-width emojis.

Stateful

This widget implements StatefulWidget, you can use it with TextAreaState to handle common actions.

Implementations

impl<'a> TextArea<'a>

pub fn new() -> TextArea<'a>

New widget.

pub fn styles_opt(self, styles: Option<TextStyle>) -> TextArea<'a>

Set the combined style.

pub fn styles(self, styles: TextStyle) -> TextArea<'a>

Set the combined style.

pub fn style(self, style: Style) -> TextArea<'a>

Base style.

pub fn focus_style(self, style: Style) -> TextArea<'a>

Style when focused.

pub fn select_style(self, style: Style) -> TextArea<'a>

Selection style.

pub fn cursor_style(self, style: impl Into<Style>) -> TextArea<'a>

Style for a rendered cursor. Only used if cursor_type is RenderedCursor.

pub fn text_style_idx(self, idx: usize, style: Style) -> TextArea<'a>

Indexed text-style.

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

pub fn text_style<T>(self, styles: T) -> TextArea<'a>

where T: IntoIterator<Item = Style>,

List of text-styles.

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

pub fn text_style_map<T>(self, styles: HashMap<usize, T>) -> TextArea<'a>

where T: Into<Style>,

Map of style_id -> text_style.

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

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

Block.

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

Set both scrollbars.

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

Set the horizontal scrollbar.

pub fn text_wrap(self, wrap: TextWrap) -> TextArea<'a>

Set the text wrapping.

pub fn set_horizontal_max_offset(self, offset: u32) -> TextArea<'a>

Maximum offset the horizontal scrollbar.

This widget doesn’t try to find a correct maximum value to show with the horizontal scroll bar, but uses this fixed value instead. This is the maximum offset that can be reached by using the scrollbar.

Finding the maximum line length for a text is rather expensive, so this widget doesn’t even try.

This doesn’t limit the column that can be reached with cursor positioning, just what can be done via the scrollbar.

See [self.set_horizontal_overscroll]

Default is 255.

pub fn set_horizontal_overscroll(self, overscroll: u32) -> TextArea<'a>

Maximum overscroll that can be reached by using the horizontal scrollbar and dragging beyond the area of the widget.

See [self.set_horizontal_max_offset]

Default is 16384.

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

Set the vertical scrollbar.

pub fn width(&self) -> u16

Preferred width: 0

pub fn height(&self) -> u16

Preferred height: 1

Trait Implementations

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

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

Returns a duplicate 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<(), Error>

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 <&TextArea<'a> as StatefulWidget>::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 StatefulWidget for TextArea<'_>

type State = TextAreaState

State associated with the stateful widget.

fn render( self, area: Rect, buf: &mut Buffer, state: &mut <TextArea<'_> as StatefulWidget>::State, )

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