Struct Clear

pub struct Clear;

A widget to clear/reset a certain area to allow overdrawing (e.g. for popups).

This widget cannot be used to clear the terminal on the first render as ratatui assumes the render area is empty. Use crate::Terminal::clear instead.

Examples

use ratatui::{
    layout::Rect,
    widgets::{Block, Clear},
    Frame,
};

fn draw_on_clear(f: &mut Frame, area: Rect) {
    let block = Block::bordered().title("Block");
    f.render_widget(Clear, area); // <- this will clear/reset the area first
    f.render_widget(block, area); // now render the block widget
}

Popup Example

For a more complete example how to utilize Clear to realize popups see the example examples/popup.rs

Trait Implementations

impl Clone for Clear

fn clone(&self) -> Clear

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Clear

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

Formats the value using the given formatter.

impl Default for Clear

fn default() -> Clear

Returns the “default value” for a type.

impl Hash for Clear

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Clear

fn eq(&self, other: &Clear) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Widget for Clear

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.

impl WidgetRef for Clear

fn render_ref(&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.

impl Eq for Clear

impl StructuralPartialEq for Clear