Skip to main content

Table

Struct Table 

Source
pub struct Table<'a> { /* private fields */ }
Expand description

A fixed-column, scrollable table with a ListState-driven highlighted row.

headers render on the first row of the area it’s rendered into; rows follow, one per line, clipped to that area. widths gives each column’s cell width; columns are space-separated and truncated to fit.

state.offset() is the index of the first row drawn below the header – rendering draws whatever window offset names and does not clamp or auto-scroll it, matching ListState’s existing “only the caller knows the viewport height” design. Call state.ensure_visible(visible_row_count) before rendering to keep state.selected() on-screen. If selected() is Some and its row falls within the visible window, that row is drawn with an inverted highlight background; if it has scrolled out of view, no row is highlighted.

header_style, row_style, and selected_style each default to a fixed palette (a light blue-gray header, a dim gray-blue for unselected rows, and a bright-white-on-dark-blue highlight for the selected row); set them with Table::header_style, Table::row_style, and Table::selected_style. column_spacing defaults to 1 (a single blank column between cells); set it with Table::column_spacing.

Implementations§

Source§

impl<'a> Table<'a>

Source

pub fn new( headers: &'a [&'a str], widths: &'a [u16], rows: &'a [Vec<String>], ) -> Self

A table with the given header labels, column widths, and rows, in the default style.

Source

pub const fn header_style(self, style: Style) -> Self

Set the header row’s style.

Source

pub const fn row_style(self, style: Style) -> Self

Set the style of unselected rows.

Source

pub const fn selected_style(self, style: Style) -> Self

Set the style of the selected row, including its background fill.

Source

pub const fn column_spacing(self, spacing: u16) -> Self

Set the number of blank columns between cells.

Source

pub fn theme(self, theme: Theme) -> Self

Applies theme’s named roles to this table’s row styles: header_style becomes theme.fg (brighter, matching the header’s original brighter-than-row default) on theme.panel_bg, row_style becomes theme.dim (the same de-emphasized role a plain body row already reads as) on theme.panel_bg, and selected_style becomes theme.bg on theme.accent – the same bright-on-accent highlight super::List::theme and super::Button::theme use.

header_style/row_style always set an explicit background rather than leaving it at Style::new()’s default: an unset background isn’t “transparent” once a real backend draws it (a bare Color::Default cell paints as solid black behind the glyph, not whatever was there before – see retroglyph-software’s DEFAULT_BG), so this widget assumes it’s drawn on theme.panel_bg – true when composed with a themed super::Panel/super::Modal, the common case – rather than risk a black box behind every row on a light Theme. Drawing this table directly on the raw screen background instead of inside a themed panel needs a manual .header_style(...)/.row_style(...) override afterwards.

Call before any manual Table::header_style/Table::row_style/ Table::selected_style override you want to keep.

Trait Implementations§

Source§

impl<'a> Clone for Table<'a>

Source§

fn clone(&self) -> Table<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for Table<'a>

Source§

impl<'a> Debug for Table<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<B: Backend> StatefulWidget<B> for Table<'_>

Source§

type State = ListState

The externally owned state this widget reads and/or updates while rendering.
Source§

fn render(self, area: Rect, term: &mut Terminal<B>, state: &mut Self::State)

Draw this widget into area, using and/or updating state.

Auto Trait Implementations§

§

impl<'a> Freeze for Table<'a>

§

impl<'a> RefUnwindSafe for Table<'a>

§

impl<'a> Send for Table<'a>

§

impl<'a> Sync for Table<'a>

§

impl<'a> Unpin for Table<'a>

§

impl<'a> UnsafeUnpin for Table<'a>

§

impl<'a> UnwindSafe for Table<'a>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<C> WithAlpha for C
where C: Copy,

Source§

fn with_alpha_first<A>(self, alpha: A) -> AlphaFirst<A, Self>

Wraps self with alpha, storing alpha before the color in memory (see AlphaFirst).
Source§

fn with_alpha_last<A>(self, alpha: A) -> AlphaLast<A, Self>

Wraps self with alpha, storing alpha after the color in memory (see AlphaLast).