
truncate the right side of left aligned titles rather than the left side of right aligned titles. This is more obvious as the left side of text often contains more important information. And we generally read left to right. This change makes centered titles overwrite left aligned titles and right aligned titles overwrite centered or left aligned titles. Fixes: https://github.com/ratatui/ratatui/issues/358
Ratatui Widgets
ratatui-widgets contains all the widgets that were previously part of the Ratatui crate.
It is meant to be used in conjunction with ratatui
, which provides the core functionality for
building terminal user interfaces.
Most applications shouldn't need to depend directly on ratatui-widgets
, ratatui
crate
re-exports all the widgets from this crate. However, if you are building a widget library that
internally uses these widgets, or if you prefer finer grained dependencies, you may want to
depend on this crate rather than transitively through the ratatui
crate.
Previously, a crate named ratatui-widgets
was published with some formative ideas about an
eventual Ratatui framework. That crate has now moved to tui-framework-experiment, pending a
new name.
Installation
Run the following command to add this crate to your project:
cargo add ratatui-widgets
Available Widgets
BarChart
: displays multiple datasets as bars with optional grouping.Block
: a basic widget that draws a block with optional borders, titles, and styles.calendar::Monthly
: displays a single month.Canvas
: draws arbitrary shapes using drawing characters.Chart
: displays multiple datasets as lines or scatter graphs.Clear
: clears the area it occupies. Useful to render over previously drawn widgets.Gauge
: displays progress percentage using block characters.LineGauge
: displays progress as a line.List
: displays a list of items and allows selection.RatatuiLogo
: displays the Ratatui logo.RatatuiMascot
: displays the Ratatui mascot.Paragraph
: displays a paragraph of optionally styled and wrapped text.Scrollbar
: displays a scrollbar.Sparkline
: displays a single dataset as a sparkline.Table
: displays multiple rows and columns in a grid and allows selection.Tabs
: displays a tab bar and allows selection.
All these widgets are re-exported directly under ratatui::widgets
in the ratatui
crate.
Contributing
Contributions are welcome! Please open an issue or submit a pull request on GitHub. For more details on contributing, please see the CONTRIBUTING document.
License
This project is licensed under the MIT License. See the LICENSE file for details.