Skip to content

README.md

Latest commit

 

History

History
74 lines (50 loc) · 2.46 KB

README.md

File metadata and controls

74 lines (50 loc) · 2.46 KB
Raw

ratatui-table

An experimental evolution of Ratatui's built-in [Table] widget.

ratatui-table starts with the Table implementation from Ratatui main at 3d8639c. Version 0.1.0 is intended to render like that built-in Table while giving Table contributors room to explore borders, virtualization, selection, marking, borrowed data, and other changes independently.

This crate is an opt-in development path for the built-in widget, not a competing Table design. If the experiment succeeds, Ratatui should be able to offer an easy upgrade or re-export path. No such re-export is implemented or promised yet.

Stability

Releases before 1.0 may make breaking changes in minor versions. Each breaking release should document how to migrate. The 0.1.0 baseline deliberately avoids folding the existing Table proposals into the initial extraction so each proposal remains independently reviewable.

Installation

cargo add ratatui-table

Example

use ratatui::layout::Constraint;
use ratatui_table::{Row, Table};

let rows = [
    Row::new(["Alice", "Engineer"]),
    Row::new(["Bob", "Designer"]),
];
let widths = [Constraint::Length(10), Constraint::Length(12)];
let table = Table::new(rows, widths);

Ratatui compatibility

[Table::block] accepts [ratatui_widgets::block::Block] to preserve the built-in API. This means the initial crate depends on ratatui-widgets with default features disabled. A future Ratatui facade can re-export this crate without requiring this crate to become part of ratatui-widgets itself.

Feature flags

  • std enables the standard-library features of the Ratatui dependencies. The Table itself remains usable with no_std plus alloc by default.
  • serde adds serialization and deserialization for [TableState] and [HighlightSpacing].

Governance

Contributors with repository Write access can review and merge ordinary Table work. Ratatui maintainers retain control of protected release configuration and approve every crates.io publication.

Contributing

Table contributors are encouraged to propose, review, and iterate on changes together. See CONTRIBUTING.md for the development and review workflow.

License

Copyright (c) 2016-2022 Florian Dehau and 2023-2025 The Ratatui Developers.

Licensed under the MIT License. See LICENSE.