Mirrors/ratatui
2
0
Fork 0
mirror of https://github.com/ratatui-org/ratatui synced 2024-11-26 14:40:30 +00:00
Code Issues Projects Releases Packages Wiki Activity

doc: update main documentation

Browse source
This commit is contained in:
Florian Dehau 2018-09-01 14:21:26 +02:00
parent 13e194cd26
commit 3d63f9607f
1 changed files with 3 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/lib.rs
View file

@ -56,7 +56,7 @@
//! //!
//! Each widget follows a builder pattern API providing a default configuration //! Each widget follows a builder pattern API providing a default configuration
//! along with methods to customize them. The widget is then registered using //! along with methods to customize them. The widget is then registered using
//! its `render` method that take a `Terminal` instance and an area to draw //! its `render` method that take a `Frame` instance and an area to draw
//! to. //! to.
//! //!
//! The following example renders a block of the size of the terminal: //! The following example renders a block of the size of the terminal:
@ -146,14 +146,10 @@
//! } //! }
//! ``` //! ```
//! //!
//! This let you describe responsive terminal UI by nesting groups. You should note //! This let you describe responsive terminal UI by nesting layouts. You should note
//! that by default the computed layout tries to fill the available space //! that by default the computed layout tries to fill the available space
//! completely. So if for any reason you might need a blank space somewhere, try to //! completely. So if for any reason you might need a blank space somewhere, try to
//! pass an additional size to the group and don't use the corresponding area inside //! pass an additional constraint and don't use the corresponding area.
//! the render method.
//!
//! Once you have finished to describe the UI, you just need to call `draw`
//! on `Terminal` to actually flush to the terminal.
#[macro_use] #[macro_use]
extern crate bitflags; extern crate bitflags;