Struct ratatui::widgets::Paragraph

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

A widget to display some text.

Examples

let text = vec![
    Spans::from(vec![
        Span::raw("First"),
        Span::styled("line",Style::default().add_modifier(Modifier::ITALIC)),
        Span::raw("."),
    ]),
    Spans::from(Span::styled("Second line", Style::default().fg(Color::Red))),
];
Paragraph::new(text)
    .block(Block::default().title("Paragraph").borders(Borders::ALL))
    .style(Style::default().fg(Color::White).bg(Color::Black))
    .alignment(Alignment::Center)
    .wrap(Wrap { trim: true });

Implementations

impl<'a> Paragraph<'a>

pub fn new<T>(text: T) -> Paragraph<'a>where T: Into<Text<'a>>,

pub fn block(self, block: Block<'a>) -> Paragraph<'a>

pub fn style(self, style: Style) -> Paragraph<'a>

pub fn wrap(self, wrap: Wrap) -> Paragraph<'a>

pub fn scroll(self, offset: (u16, u16)) -> Paragraph<'a>

pub fn alignment(self, alignment: Alignment) -> Paragraph<'a>

Trait Implementations

impl<'a> Clone for Paragraph<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Paragraph<'a>

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

Formats the value using the given formatter.

impl<'a> Widget for Paragraph<'a>

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.