ratatui/ratatui-core
Josh McKinney 4eac5b2849
fix: make deprecation notes more helpful (#1702)
AI coding assistants use the deprecation notes to automatically suggest
fixes. This commit updates the deprecation notes to push those tools to
suggest the correct replacement methods and types.

Specifically, AI tools often suggest using `Buffer::get(x, y)`, because
of their training data where this was prevalent. When fixing these
deprecations, they often incorrectly suggest using `Buffer::get(x, y)`
instead of `Buffer[(x, y)]`.
2025-03-04 11:56:44 -08:00
..
2025-03-01 15:34:53 -08:00

Ratatui Core

Crates.io Documentation License

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.