mirror of
https://github.com/ratatui/ratatui.git
synced 2025-09-29 22:11:34 +00:00
5620e06b1a
Adds summary-level crate organization documentation to all crates explaining the modular workspace structure and when to use each crate. Links to ARCHITECTURE.md for detailed information.
68 lines
2.5 KiB
Markdown
68 lines
2.5 KiB
Markdown
# Ratatui Core
|
|
|
|
[](https://crates.io/crates/ratatui-core)
|
|
[](https://docs.rs/ratatui-core)
|
|
[](../LICENSE)
|
|
|
|
<!-- ⚠️ DO NOT EDIT THIS FILE DIRECTLY, EDIT lib.rs AND THEN RUN `cargo rdme` to update this file. -->
|
|
<!-- cargo-rdme start -->
|
|
|
|
**ratatui-core** is the core library of the [ratatui] project,
|
|
providing the essential building blocks for creating rich terminal user interfaces in Rust.
|
|
|
|
[ratatui]: https://github.com/ratatui/ratatui
|
|
|
|
### Why `ratatui-core`?
|
|
|
|
The `ratatui-core` crate is split from the main [`ratatui`](https://crates.io/crates/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`:
|
|
|
|
```shell
|
|
cargo add ratatui-core
|
|
```
|
|
|
|
## Crate Organization
|
|
|
|
`ratatui-core` is part of the Ratatui workspace that was modularized in version 0.30.0 to
|
|
improve compilation times, API stability, and dependency management. This crate provides the
|
|
foundational types and traits that other crates in the workspace depend on.
|
|
|
|
**When to use `ratatui-core`:**
|
|
|
|
- Building widget libraries that implement [`Widget`] or [`StatefulWidget`]
|
|
- Creating lightweight applications that don't need built-in widgets
|
|
- You want minimal dependencies and faster compilation times
|
|
- You need maximum API stability (core types change less frequently)
|
|
|
|
**When to use the main [`ratatui`] crate:**
|
|
|
|
- Building applications that use built-in widgets
|
|
- You want convenience and don't mind slightly longer compilation times
|
|
- You need backend implementations and terminal management utilities
|
|
|
|
For detailed information about the workspace organization, see [ARCHITECTURE.md].
|
|
|
|
[`ratatui`]: https://crates.io/crates/ratatui
|
|
[`Widget`]: widgets::Widget
|
|
[`StatefulWidget`]: widgets::StatefulWidget
|
|
[ARCHITECTURE.md]: https://github.com/ratatui/ratatui/blob/main/ARCHITECTURE.md
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions from the community! Please see our [CONTRIBUTING](../CONTRIBUTING.md)
|
|
guide for more details on how to get involved.
|
|
|
|
### License
|
|
|
|
This project is licensed under the MIT License. See the [LICENSE](../LICENSE) file for details.
|
|
|
|
<!-- cargo-rdme end -->
|