itsscb/ratatui
1
0
Fork 0
mirror of https://github.com/ratatui/ratatui.git synced 2025-09-26 20:40:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
ratatui/ratatui-core
History
eqsdxr 40f13c6a6c
docs(rect): update the outdated comment for Rect::area() (#2100) 
The return value of Rect.area() is no longer of u16 type, and the value
is not being clumped anymore.
2025-09-25 22:35:05 +03:00
..
src
docs(rect): update the outdated comment for Rect::area() (#2100)
2025-09-25 22:35:05 +03:00
Cargo.toml
feat(no_std): portable-atomic integration for targets with no atomic types (#2076)
2025-09-04 20:14:25 +02:00
README.md
docs: add crate organization sections to workspace (#1946)
2025-06-26 15:36:00 -07:00

README.md

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

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.

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.