Struct Table 

pub struct Table {

    pub common: Common,
    pub header: Option<Row>,
    pub rows: Vec<Row>,
    pub footer: Option<Row>,
    pub widths: Vec<Constraint>,
    pub column_spacing: Option<u16>,
    pub row_highlight_style: Option<Style>,
    pub highlight_symbol: Option<String>,
    pub highlight_spacing: Option<HighlightSpacing>,
    pub state: Option<ListState>,
    pub sticky: Option<Sticky>,
    pub scrollbar: Option<bool>,
    pub on_select: Option<ActionId>,
    pub on_activate: Option<ActionId>,
}

ratatui Table (§4.5.1). Column widths are solved horizontally like a Layout.

Fields

common: Common

Common node props (key, style, block, fallback).

header: Option<Row>

Header row.

rows: Vec<Row>

Body rows (≤ 5 000, §4.8).

footer: Option<Row>

Footer row.

widths: Vec<Constraint>

One width constraint per column.

column_spacing: Option<u16>

Gap between columns (default 1).

row_highlight_style: Option<Style>

Selected-row style.

highlight_symbol: Option<String>

Prefix drawn before the selected row.

highlight_spacing: Option<HighlightSpacing>

Space reserved for the highlight symbol.

state: Option<ListState>

Selection / offset state (wins when it changes, §4.6).

sticky: Option<Sticky>

GUI extra: sticky first column.

scrollbar: Option<bool>

GUI extra: native scrollbar.

on_select: Option<ActionId>

Action on selection change (row key).

on_activate: Option<ActionId>

Action on Enter (row key).

Implementations

impl Table

pub fn new( rows: impl IntoIterator<Item = impl Into<Row>>, widths: impl IntoIterator<Item = Constraint>, ) -> Self

A table from rows and column widths.

pub fn header(self, header: impl Into<Row>) -> Self

Sets the header row.

pub fn footer(self, footer: impl Into<Row>) -> Self

Sets the footer row.

pub fn widths(self, widths: impl IntoIterator<Item = Constraint>) -> Self

Sets the column width constraints.

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

Sets the column gap.

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

Sets the selected-row style.

pub fn highlight_symbol(self, symbol: impl Into<String>) -> Self

Sets the prefix drawn before the selected row.

pub fn highlight_spacing(self, spacing: HighlightSpacing) -> Self

Sets the highlight-symbol spacing policy.

pub fn state(self, state: ListState) -> Self

Sets the selection / offset state.

pub fn sticky(self, sticky: Sticky) -> Self

GUI extra: sticky first column.

pub fn scrollbar(self, scrollbar: bool) -> Self

GUI extra: native scrollbar.

pub fn on_select(self, action: impl Into<ActionId>) -> Self

Sets the selection action.

pub fn on_activate(self, action: impl Into<ActionId>) -> Self

Sets the activate action.

Trait Implementations

impl Clone for Table

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Table

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

Formats the value using the given formatter.

impl Default for Table

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Table

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Table> for Node

fn from(t: Table) -> Self

Converts to this type from the input type.

impl IntoNode for Table

fn into_node(self) -> Node

Converts into a node.

impl PartialEq for Table

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Table

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Table

impl WithCommon for Table

fn common_mut(&mut self) -> &mut Common

Mutable access to the node’s common props.

fn key(self, key: impl Into<Key>) -> Self

Sets the node key.

fn style(self, style: Style) -> Self

Sets the base style.

fn block(self, block: impl Into<BlockProps>) -> Self

Sets the surrounding block.

fn fallback(self, node: impl Into<Node>) -> Self

Sets the fallback node.