Struct ratatui::text::TextCopy item path

Create some text (potentially multiple lines) with no style.

§Examples

Text::raw("The first line\nThe second line");
Text::raw(String::from("The first line\nThe second line"));

Create some text (potentially multiple lines) with a style.

style accepts any type that is convertible to Style (e.g. Style, Color, or your own type that implements Into<Style>).

§Examples

let style = Style::default()
    .fg(Color::Yellow)
    .add_modifier(Modifier::ITALIC);
Text::styled("The first line\nThe second line", style);
Text::styled(String::from("The first line\nThe second line"), style);

Returns the max width of all the lines.

§Examples

let text = Text::from("The first line\nThe second line");
assert_eq!(15, text.width());

Returns the height.

§Examples

let text = Text::from("The first line\nThe second line");
assert_eq!(2, text.height());

Sets the style of this text.

Defaults to Style::default().

Note: This field was added in v0.26.0. Prior to that, the style of a text was determined only by the style of each Line contained in the line. For this reason, this field may not be supported by all widgets (outside of the ratatui crate itself).

style accepts any type that is convertible to Style (e.g. Style, Color, or your own type that implements Into<Style>).

§Examples

let mut line = Text::from("foo").style(Style::new().red());

Patches the style of this Text, adding modifiers from the given style.

This is useful for when you want to apply a style to a text that already has some styling. In contrast to Text::style, this method will not overwrite the existing style, but instead will add the given style’s modifiers to this text’s style.

Text also implements Styled which means you can use the methods of the Stylize trait.

style accepts any type that is convertible to Style (e.g. Style, Color, or your own type that implements Into<Style>).

This is a fluent setter method which must be chained or used as it consumes self

§Examples

let raw_text = Text::styled("The first line\nThe second line", Modifier::ITALIC);
let styled_text = Text::styled(
    String::from("The first line\nThe second line"),
    (Color::Yellow, Modifier::ITALIC),
);
assert_ne!(raw_text, styled_text);

let raw_text = raw_text.patch_style(Color::Yellow);
assert_eq!(raw_text, styled_text);

Resets the style of the Text.

Equivalent to calling patch_style(Style::reset()).

This is a fluent setter method which must be chained or used as it consumes self

§Examples

let text = Text::styled(
    "The first line\nThe second line",
    (Color::Yellow, Modifier::ITALIC),
);

let text = text.reset_style();
assert_eq!(Style::reset(), text.style);

Sets the alignment for this text.

Defaults to: None, meaning the alignment is determined by the rendering widget. Setting the alignment of a Text generally overrides the alignment of its parent Widget.

Alignment can be set individually on each line to override this text’s alignment.

§Examples

Set alignment to the whole text.

let mut text = Text::from("Hi, what's up?");
assert_eq!(None, text.alignment);
assert_eq!(
    Some(Alignment::Right),
    text.alignment(Alignment::Right).alignment
)

Set a default alignment and override it on a per line basis.

let text = Text::from(vec![
    Line::from("left").alignment(Alignment::Left),
    Line::from("default"),
    Line::from("default"),
    Line::from("right").alignment(Alignment::Right),
])
.alignment(Alignment::Center);

Will render the following

left
  default
  default
      right

Left-aligns the whole text.

Convenience shortcut for Text::alignment(Alignment::Left). Setting the alignment of a Text generally overrides the alignment of its parent Widget, with the default alignment being inherited from the parent.

Alignment can be set individually on each line to override this text’s alignment.

§Examples

let text = Text::from("Hi, what's up?").left_aligned();

Center-aligns the whole text.

Convenience shortcut for Text::alignment(Alignment::Center). Setting the alignment of a Text generally overrides the alignment of its parent Widget, with the default alignment being inherited from the parent.

Alignment can be set individually on each line to override this text’s alignment.

§Examples

let text = Text::from("Hi, what's up?").centered();

Right-aligns the whole text.

Convenience shortcut for Text::alignment(Alignment::Right). Setting the alignment of a Text generally overrides the alignment of its parent Widget, with the default alignment being inherited from the parent.

Alignment can be set individually on each line to override this text’s alignment.

§Examples

let text = Text::from("Hi, what's up?").right_aligned();

Returns an iterator over the lines of the text.

Returns an iterator that allows modifying each line.

Adds a line to the text.

line can be any type that can be converted into a Line. For example, you can pass a &str, a String, a Span, or a Line.

§Examples

let mut text = Text::from("Hello, world!");
text.push_line(Line::from("How are you?"));
text.push_line(Span::from("How are you?"));
text.push_line("How are you?");

Adds a span to the last line of the text.

span can be any type that is convertible into a Span. For example, you can pass a &str, a String, or a Span.

§Examples

let mut text = Text::from("Hello, world!");
text.push_span(Span::from("How are you?"));
text.push_span("How are you?");

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.