
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::*; ```
Ratatui Core
ratatui-core is the core library of the ratatui project, providing the essential building blocks for creating rich terminal user interfaces in Rust.
Why ratatui-core
?
The ratatui-core
crate is split from the main ratatui
crate
to offer better stability for widget library authors. Widget libraries should generally depend
on ratatui-core
, benefiting from a stable API and reducing the need for frequent updates.
Applications, on the other hand, should depend on the main ratatui
crate, which includes
built-in widgets and additional features.
Installation
Add ratatui-core
to your Cargo.toml
:
cargo add ratatui-core
Contributing
We welcome contributions from the community! Please see our CONTRIBUTING guide for more details on how to get involved.
License
This project is licensed under the MIT License. See the LICENSE file for details.