better-cursive-table 0.2.0

TableView and ArrayView for Cursive TUIs
Documentation

better_cursive_table

TableView and ArrayView widgets for the cursive TUI framework. This is a maintained fork of cursive_table_view with all original functionality plus a toggle to disable sorting and header selection.

Highlights

  • TableView with multi-column sort and keyboard/mouse navigation
  • ArrayView for labeled rows + columns (a 2D grid with headers)
  • Chainable column configuration (alignment, width, default order)
  • Callbacks for sort, row select, and submit
  • Optional non-sortable mode for "static" tables

TableView example Non-sortable table example ArrayView example

Install

Add to your Cargo.toml:

[dependencies]
better_cursive_table = "0.2"
cursive = "0.21"

Quick start (TableView)

use std::cmp::Ordering;
use cursive::align::HAlign;
use cursive::traits::*;
use better_cursive_table::{TableView, TableViewItem};

#[derive(Copy, Clone, PartialEq, Eq, Hash)]
enum Column {
    Name,
    Count,
    Rate,
}

#[derive(Clone, Debug)]
struct Row {
    name: String,
    count: usize,
    rate: usize,
}

impl TableViewItem<Column> for Row {
    fn to_column(&self, column: Column) -> String {
        match column {
            Column::Name => self.name.clone(),
            Column::Count => self.count.to_string(),
            Column::Rate => self.rate.to_string(),
        }
    }

    fn cmp(&self, other: &Self, column: Column) -> Ordering {
        match column {
            Column::Name => self.name.cmp(&other.name),
            Column::Count => self.count.cmp(&other.count),
            Column::Rate => self.rate.cmp(&other.rate),
        }
    }
}

let mut table = TableView::<Row, Column>::new()
    .column(Column::Name, "Name", |c| c.width_percent(30))
    .column(Column::Count, "Count", |c| c.align(HAlign::Center))
    .column(Column::Rate, "Rate", |c| {
        c.ordering(Ordering::Greater).align(HAlign::Right).width_percent(20)
    })
    .default_column(Column::Name);

table.set_items(vec![
    Row { name: "Alpha".into(), count: 3, rate: 10 },
    Row { name: "Beta".into(), count: 1, rate: 42 },
]);

Sorting disabled

Disable header selection and sort indicators entirely:

let table = TableView::<Row, Column>::new()
    .column(Column::Name, "Name", |c| c)
    .column(Column::Count, "Count", |c| c)
    .sortable(false);

ArrayView (row + column headers)

use cursive::align::HAlign;
use better_cursive_table::{ArrayView, ArrayViewItem};

#[derive(Copy, Clone, PartialEq, Eq, Hash)]
enum Axis {
    X,
    Y,
    Z,
}

#[derive(Clone)]
struct CellRow {
    label: String,
    values: [i32; 3],
}

impl ArrayViewItem<Axis> for CellRow {
    fn to_column(&self, column: Axis) -> String {
        match column {
            Axis::X => self.values[0].to_string(),
            Axis::Y => self.values[1].to_string(),
            Axis::Z => self.values[2].to_string(),
        }
    }

    fn to_row(&self) -> String {
        self.label.clone()
    }
}

let mut array = ArrayView::<CellRow, Axis>::new()
    .row_header(|h| h.width(6))
    .column(Axis::X, "X", |c| c.align(HAlign::Center))
    .column(Axis::Y, "Y", |c| c.align(HAlign::Center))
    .column(Axis::Z, "Z", |c| c.align(HAlign::Center));

Callbacks

use std::cmp::Ordering;
use cursive::Cursive;

table.set_on_sort(|_siv: &mut Cursive, column, order: Ordering| {
    // React to sorting (e.g., update status line)
});

table.set_on_select(|_siv: &mut Cursive, row, index| {
    // Row changed
});

table.set_on_submit(|_siv: &mut Cursive, row, index| {
    // Enter key / click on focused row
});

License

Licensed under either of:

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as above, without any additional terms or conditions.