Struct TableState 

pub struct TableState<T: TableRow> { /* private fields */ }

State for a Table component.

Holds the rows, columns, selection state, and sort configuration.

Implementations

impl<T: TableRow> TableState<T>

pub fn new(rows: Vec<T>, columns: Vec<Column>) -> Self

Creates a new table state with the given rows and columns.

If there are rows, the first row is selected by default.

Example

use envision::component::{Column, TableRow, TableState};
use ratatui::layout::Constraint;

#[derive(Clone)]
struct Item { name: String }

impl TableRow for Item {
    fn cells(&self) -> Vec<String> {
        vec![self.name.clone()]
    }
}

let state = TableState::new(
    vec![Item { name: "A".into() }, Item { name: "B".into() }],
    vec![Column::new("Name", Constraint::Length(10))],
);
assert_eq!(state.len(), 2);
assert_eq!(state.selected_index(), Some(0));

pub fn with_selected( rows: Vec<T>, columns: Vec<Column>, selected: usize, ) -> Self

Creates a table state with a specific row selected.

The index is clamped to the valid range.

pub fn rows(&self) -> &[T]

Returns a reference to the rows.

pub fn columns(&self) -> &[Column]

Returns a reference to the columns.

pub fn selected_index(&self) -> Option<usize>

Returns the currently selected display index.

This is the index in the display order, not the original row index.

pub fn selected_row(&self) -> Option<&T>

Returns a reference to the currently selected row.

Returns None if no row is selected or the table is empty.

pub fn sort(&self) -> Option<(usize, SortDirection)>

Returns the current sort configuration.

Returns None if no sort is applied.

pub fn len(&self) -> usize

Returns the number of rows.

pub fn is_empty(&self) -> bool

Returns true if the table has no rows.

pub fn set_rows(&mut self, rows: Vec<T>)

Sets the rows, resetting sort and adjusting selection.

If there were rows selected, the selection is preserved if valid, otherwise clamped to the last row.

pub fn set_selected(&mut self, index: Option<usize>)

Sets the selected row by display index.

Pass None to clear the selection. Out of bounds indices are ignored.

pub fn is_disabled(&self) -> bool

Returns true if the table is disabled.

pub fn set_disabled(&mut self, disabled: bool)

Sets the disabled state.

Disabled tables do not respond to messages.

Trait Implementations

impl<T: Clone + TableRow> Clone for TableState<T>

fn clone(&self) -> TableState<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + TableRow> Debug for TableState<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: TableRow> Default for TableState<T>

fn default() -> Self

Returns the “default value” for a type.