Struct Paragraph 

pub struct Paragraph { /* private fields */ }

A widget combining multiple widgets implementing the Text trait into single widget. A Paragraph combines multiple widgets implementing the Text trait into single widget, displaying them sequantially with configurable separator.

Unlike layout-based widgets, Paragraph places spans directly next to each other, allowing for more natural inline text composition.

Example

// Creates a Paragraph from a list of spans
let items: Vec<Box<dyn Text>> = vec![
    Box::new("This is a text in".fg(Color::Yellow)),
    Box::new("paragraph".modifier(Modifier::BOLD).fg(Color::Cyan)),
    Box::new("and it adds".to_span()),
    Box::new("separator".modifier(Modifier::ITALIC)),
];
let mut p = Paragraph::new(items)
    .wrap(Wrap::Letter)
    .separator("-");

// Alternatively, use the `paragraph!` macro for convenience
let mut p = paragraph!(
    "This is a text in".fg(Color::Yellow),
    "paragraph".modifier(Modifier::BOLD).fg(Color::Cyan),
    "and it adds".to_span(),
    "separator".modifier(Modifier::ITALIC),
);
// Add more text later if needed
p.push("between each span");

// Print the Paragraph as a string
println!("{p}");

// Or you can render it using `Term` (or manually using `Buffer`)
let mut term = Term::default();
term.render(p)?;

Implementations

impl Paragraph

pub fn new(children: Vec<Box<dyn Text>>) -> Self

Creates a new Paragraph with the given child elements.

pub fn empty() -> Self

Creates an empty Paragraph with no children.

pub fn get(&self) -> String

Gets the rendered content of the Paragraph as a String, joining all child elements with the configured separator.

It ignores wrapping and any other position based settings.

pub fn separator(self, sep: &str) -> Self

Sets the separator used between child elements when rendering the Paragraph.

pub fn wrap(self, wrap: Wrap) -> Self

Sets text wrapping style of the Paragraph.

Default value is Wrap::Word.

pub fn add<T>(&mut self, child: T)

where T: Into<Box<dyn Text>>,

👎Deprecated since 0.6.0: Kept for compatibility purposes; use push function instead

Adds a child element to the Paragraph

pub fn push<T>(&mut self, child: T)

where T: Into<Box<dyn Text>>,

Adds a child element to the Paragraph

Trait Implementations

impl Debug for Paragraph

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

Formats the value using the given formatter.

impl Default for Paragraph

fn default() -> Self

Creates Paragraph filled with default values

impl Display for Paragraph

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

Formats the value using the given formatter.

impl From<Paragraph> for Box<dyn Widget>

fn from(value: Paragraph) -> Self

Converts to this type from the input type.

impl From<Paragraph> for Element

fn from(value: Paragraph) -> Self

Converts to this type from the input type.

impl Widget for Paragraph

fn render(&self, buffer: &mut Buffer, rect: Rect, _cache: &mut Cache)

Renders the widget into the given Buffer within the provided Rect bounds.

fn height(&self, size: &Vec2) -> usize

Returns the height of the Widget based on the width of the given size.

fn width(&self, size: &Vec2) -> usize

Returns the width of the Widget based on the height of the given size.

fn children(&self) -> Vec<&Element>

Gets widget’s children