Struct LabeledTextArea

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

Labeled Text Area

A variant of TextArea that adds a themed block around the text area and a reactive header with a title, an optional subtitle, and an optional twitter-like character count.

Implementations

impl<'a> LabeledTextArea<'a>

pub fn new(th: LabeledTextAreaTheme) -> Self

Create a new LabeledTextArea with the given LabeledTextAreaTheme.

pub fn with_validations( self, validations: impl IntoIterator<Item = impl Fn(&str) -> Result<(), String> + Send + Sync + 'static>, ) -> Self

pub fn is_valid(&self) -> bool

pub fn validate(&mut self) -> ValidationResult

pub fn set_active(&mut self, active: bool)

Set the text area to be active or not.

pub fn is_active(&self) -> bool

Get the active status of the text area.

pub fn with_title(self, title: impl Into<String>) -> Self

Set the title of the text area.

pub fn with_subtitle(self, subtitle: impl Into<String>) -> Self

Set the subtitle of the text area.

pub fn with_active(self, active: bool) -> Self

Set the active status of the text area.

pub fn with_max_char_count(self, max_char_count: usize) -> Self

Set the maximum character count for the text area.

pub fn set_max_char_count(&mut self, max_char_count: usize)

Set the maximum character count for the text area.

pub fn with_single_line(self, single_line: bool) -> Self

Set the text area to be single line or not.

pub fn lines(&'a self) -> &'a [String]

Get the text area lines.

pub fn text(&self) -> String

Get the text area text.

pub fn char_count(&self) -> usize

pub fn input(&mut self, input: impl Into<Input>) -> bool

pub fn get_rect(&self, area: Rect) -> Rect

pub fn get_height(&self) -> u16

pub fn is_touched(&self) -> bool

Get the touched status of the text area.

A text area is considered touched if it has been active at least once. This is useful to know if the user has interacted with the text area.

Trait Implementations

impl<'a> Clone for LabeledTextArea<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Default for LabeledTextArea<'a>

fn default() -> Self

Returns the “default value” for a type.

impl Widget for &LabeledTextArea<'_>

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

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