Skip to main content

Table

Struct Table 

Source
pub struct Table { /* private fields */ }
Expand description

A table component with sortable columns, row selection, and interactive filtering.

Renders as a header row, a separator line, and data rows. The selected row shows a > prefix and is highlighted with the theme’s accent color when the table is focused.

§Hooks

  • on_select — fired when the user navigates rows.
  • on_sort — fired when sort column or direction changes.
  • on_filter — fired when the filter query changes.
  • on_filter_char — transforms or rejects filter characters during interactive filter mode.

Implementations§

Source§

impl Table

Source

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

Create a new table with the given columns and rows.

Source

pub fn selected(&self) -> usize

Index of the currently selected visible row.

Source

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

Set the selected row index (clamped to valid visible range).

Source

pub fn set_sort_column(&mut self, column: Option<usize>)

Set the column used for sorting display.

Source

pub fn set_sort_ascending(&mut self, ascending: bool)

Set whether the current sort is ascending.

Source

pub fn sort_by(&mut self, column: usize)

Sort by the given column index. Toggles direction if already sorting by the same column. Does nothing if the column is not sortable.

Source

pub fn clear_sort(&mut self)

Clear sorting and restore original row order.

Source

pub fn set_filter(&mut self, query: impl Into<String>)

Set a filter query. Only rows with at least one cell containing the query (case-insensitive) are displayed.

Source

pub fn clear_filter(&mut self)

Clear the filter and show all rows.

Source

pub fn filter_query(&self) -> Option<&str>

Return the current filter query, if any.

Source

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

Return the current sort column, if any.

Source

pub fn sort_ascending(&self) -> bool

Return whether the current sort is ascending.

Source

pub fn in_filter_mode(&self) -> bool

Return true if the table is currently accepting interactive filter input.

Source

pub fn displayed_row_count(&self) -> usize

Return the number of rows currently displayed (after filtering).

Source

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

Return the original row index of the currently selected visible row.

Source

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

Return a reference to the currently selected visible row.

Source

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

Replace the rows and recompute the display order.

Source

pub fn on_select(self, cb: impl Fn(usize) + 'static) -> Self

Attach a callback invoked when the selected row changes via keyboard navigation.

Source

pub fn on_sort(self, cb: impl Fn(usize, bool) + 'static) -> Self

Attach a callback invoked when sort column or direction changes.

Source

pub fn on_filter(self, cb: impl Fn(&str) + 'static) -> Self

Attach a callback invoked when the filter query changes.

Source

pub fn on_filter_char(self, cb: impl Fn(char) -> Option<char> + 'static) -> Self

Attach a callback invoked for each character typed in interactive filter mode. Return Some(transformed) to accept the character (possibly modified) or None to reject it.

Source

pub fn filter_key(self, key: char) -> Self

Set the key that enters interactive filter mode. Defaults to '/'.

Source

pub fn sort_indicator_asc(self, indicator: impl Into<String>) -> Self

Set the indicator shown next to a column header when sorted ascending.

Source

pub fn sort_indicator_desc(self, indicator: impl Into<String>) -> Self

Set the indicator shown next to a column header when sorted descending.

Trait Implementations§

Source§

impl Component for Table

Source§

fn render(&self, width: u16) -> Result<Rendered, RenderError>

Render this component into lines of text at the given width. Read more
Source§

fn handle_input(&mut self, event: &Event) -> InputResult

Handle an input event (key press, resize, mouse, etc.). Read more
Source§

fn as_focusable(&self) -> Option<&dyn Focusable>

Cast this component to a Focusable reference, if supported.
Source§

fn as_focusable_mut(&mut self) -> Option<&mut dyn Focusable>

Cast this component to a mutable Focusable reference, if supported.
Source§

fn render_rect(&self, rect: Rect) -> Result<Rendered, RenderError>

Render this component into a specific rectangular area. Read more
Source§

fn wants_key_release(&self) -> bool

Returns true if this component wants to receive KeyEventKind::Release events in addition to Press / Repeat. Read more
Source§

impl Focusable for Table

Source§

fn focused(&self) -> bool

Returns true when this component currently has focus.
Source§

fn set_focused(&mut self, focused: bool)

Set or clear the focused state.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Table

§

impl !Send for Table

§

impl !Sync for Table

§

impl !UnwindSafe for Table

§

impl Freeze for Table

§

impl Unpin for Table

§

impl UnsafeUnpin for Table

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.