Struct tui::widgets::Paragraph

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

A widget to display some text. You can specify colors using commands embedded in the text such as "{[color] [text]}".

Examples

Paragraph::default()
    .block(Block::default().title("Paragraph").borders(Borders::ALL))
    .style(Style::default().fg(Color::White).bg(Color::Black))
    .wrap(true)
    .text("First line\nSecond line\n{red Colored text}.");

Methods

impl<'a> Paragraph<'a>

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

pub fn text(&mut self, text: &'a str) -> &mut Paragraph<'a>

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

pub fn wrap(&mut self, flag: bool) -> &mut Paragraph<'a>

pub fn raw(&mut self, flag: bool) -> &mut Paragraph<'a>

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

Trait Implementations

impl<'a> Default for Paragraph<'a>

fn default() -> Paragraph<'a>

Returns the "default value" for a type.

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

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

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

fn background(&self, area: &Rect, buf: &mut Buffer, color: Color)

Helper method to quickly set the background of all cells inside the specified area.

fn render<B>(&mut self, t: &mut Terminal<B>, area: &Rect) where
    Self: Sized,
    B: Backend, 

Helper method that can be chained with a widget's builder methods to render it.