Struct TextArea 

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

A styled multi-line text input.

let mut notes = String::new();
ui.add(
    TextArea::new(&mut notes)
        .label("Notes")
        .hint("Jot anything down…")
        .rows(6),
);

Ids, focus, and flash state

As with TextInput, pin a stable id_salt on any TextArea you plan to flash — otherwise the id is layout-dependent and in-flight flash/focus/cursor state is lost if siblings above this widget appear or disappear between frames.

Implementations

impl<'a> TextArea<'a>

pub fn new(text: &'a mut String) -> Self

Create a multi-line text input bound to text.

pub fn label(self, text: impl Into<WidgetText>) -> Self

Show a label above the text area.

pub fn hint(self, text: &'a str) -> Self

Show placeholder-style hint text when the field is empty.

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

Mark the input as having unsaved changes. Shows a sky-coloured accent bar down the left side.

pub fn rows(self, rows: usize) -> Self

Minimum visible row count. Default: 5.

pub fn desired_width(self, width: f32) -> Self

Desired width (points) for the editor portion of the widget.

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

Render the text in the theme’s monospace font. Useful for code, JSON blobs, PEM keys, and similar fixed-width content.

pub fn id_salt(self, id: impl Hash) -> Self

Supply a stable id salt. Required if you plan to flash this widget via ResponseFlashExt.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<'a> Widget for TextArea<'a>

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response.