Struct TextArea 

pub struct TextArea<Msg> { /* private fields */ }

A multi-line text field with word wrap, scrolling and real editing.

Long lines wrap at word boundaries and the area scrolls vertically with a scrollbar once the text is taller than the area. The area measures three to eight rows, growing with its content; give the node a height for a fixed size. The application owns the value and receives every change through on_change; cursor, selection, scroll and undo history live in the runtime.

Keys: Enter inserts a line break. ←/→ move (with Ctrl by word), ↑/↓ move between rows keeping the column, Page Up/Page Down move a page, Home/End go to the row’s start and end (with Ctrl to the text’s), and Shift extends the selection with any of them. Without Shift an arrow clears a selection and moves one step on from its end in that direction. Backspace and Delete, Ctrl+W deletes a word, Ctrl+U deletes to the line start, Ctrl+A selects all, Ctrl+Z undo, Ctrl+Y or Ctrl+Shift+Z redo, Ctrl+C and Ctrl+X copy and cut. Ctrl+Enter submits when TextArea::on_submit is set; terminals without the kitty keyboard protocol may not report it, so offer a button as well. Pasting keeps line breaks. Clicking places the cursor, dragging selects, the wheel and the scrollbar scroll.

A right click (or Shift+F10 and the menu key) opens the edit menu of TextInput: Cut, Copy, Paste and Select all, with the same rules.

Style keys: text-area (bg, fg, padding) with hover, focus, invalid, disabled; text-area-line-number (fg) with selected on the cursor’s line; text-area-counter (fg); and the text input’s text-input-placeholder, text-input-selection, text-input-cursor and scrollbar.

Implementations

impl<Msg: 'static> TextArea<Msg>

pub fn new(value: impl Into<String>) -> Self

An area showing value.

pub fn placeholder(self, text: impl Into<String>) -> Self

Faint text shown while the area is empty.

pub fn invalid(self, invalid: bool) -> Self

Marks the value as failing validation.

pub fn disabled(self, disabled: bool) -> Self

Makes the area read-only and unfocusable.

pub fn max_length(self, max: usize) -> Self

Limits the value to max characters; a line break counts as one.

pub fn line_numbers(self, on: bool) -> Self

Numbers every line in a faint column on the left; wrapped rows are not numbered.

pub fn counter(self, on: bool) -> Self

Shows the character count on a row below the text, with the limit when there is one.

pub fn on_change(self, message: impl Fn(String) -> Msg + 'static) -> Self

Message carrying the new value after every edit.

pub fn on_submit(self, message: impl Fn(String) -> Msg + 'static) -> Self

Message carrying the value when Ctrl+Enter is pressed.

Trait Implementations

impl<Msg: 'static> Widget<Msg> for TextArea<Msg>

fn measure(&self, cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn paint_overlay(&self, cx: &mut PaintCx<'_>, anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.