Mirrors/ratatui
2
0
Fork 0
mirror of https://github.com/ratatui-org/ratatui synced 2025-02-16 22:18:51 +00:00
Code Issues Projects Releases Packages Wiki Activity

doc(widgets/clear): clarify usage of clear

Browse source
This commit is contained in:
Florian Dehau 2021-06-16 20:41:53 +02:00
parent 8da5f740af
commit fbd834469f
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/widgets/clear.rs
View file

@ -1,8 +1,9 @@
use crate::buffer::Buffer;
use crate::layout::Rect;
use crate::widgets::Widget;
use crate::{buffer::Buffer, layout::Rect, widgets::Widget};
/// A widget to to clear/reset a certain area to allow overdrawing (e.g. for popups)
/// 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 `tui` assumes the
/// render area is empty. Use [`crate::Terminal::clear`] instead.
///
/// # Examples
///