itsscb/ratatui
1
0
Fork 0
mirror of https://github.com/ratatui/ratatui.git synced 2025-09-28 05:21:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
ratatui/ratatui-core
History
Josh McKinney 357ae7e251
chore: move terminal types to ratatui-core (#1530) 
- Move Terminal, TerminalOptions, ViewPort, CompletedFrame, Frame to
  ratatui-core crate
- Move render_widget_ref() and render_stateful_widget_ref() to extension
  trait (FrameExt) due as the Ref types are unstable and kept in the
  main lib instead of -core
- Fix rustdoc errors / feature config issues

BREAKING CHANGE: to call `Frame::render_widget_ref()` or
`Frame::render_stateful_widget_ref()` you now need to import the
FrameExt trait from `ratatui::widgets` and enable the
`unstable-widget-ref` feature.

Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
2024-11-30 17:11:17 -08:00
..
src
chore: move terminal types to ratatui-core (#1530)
2024-11-30 17:11:17 -08:00
Cargo.toml
chore(lint): ensure lint config is correct (#1528)
2024-11-30 11:13:50 +03:00
README.md
docs: improve docs for workspace crates (#1490)
2024-11-18 02:03:44 +03: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

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.