mirror of https://github.com/ratatui/ratatui.git synced 2025-09-27 04:50:46 +00:00

History

feat!: rename Alignment to HorizontalAlignment and add VerticalAlignment (#1735 )

We don't anticipate removing or deprecating the type alias in the near
future, but it is recommended to update your imports to use the new
name.

Added a VerticalAlignment enum to make the API more consistent. We don't
have a specific use case for it yet, but it's better to add it now and
be able to use it in the future.

BREAKING-CHANGE: The `Alignment` enum has been renamed to
`HorizontalAlignment` to better reflect its purpose. A type alias has
been added to maintain backwards compatibility, however there are some
cases where type aliases are not enough to maintain backwards
compatibility. E.g. when using glob imports to import all the enum
variants. This should not affect most users, but it is recommended to
update your imports to use the new name.

```diff
- use ratatui::layout::Alignment;
+ use ratatui::layout::HorizontalAlignment;

- use Alignment::*;
+ use HorizontalAlignment::*;
```

2025-04-06 20:00:59 +03:00

examples

style: use Module imports_granularity (#1728 )

2025-03-19 16:48:02 -07:00

src

feat!: rename Alignment to HorizontalAlignment and add VerticalAlignment (#1735 )

2025-04-06 20:00:59 +03:00

Cargo.toml

style: use Module imports_granularity (#1728 )

2025-03-19 16:48:02 -07:00

README.md

feat: add a new RatatuiMascot widget (#1584 )

2024-12-26 04:32:38 -08:00

README.md

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 is now move 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.