Struct Table 

pub struct Table {
    pub key_map: KeyMap,
    pub styles: Styles,
    pub mouse_wheel_enabled: bool,
    pub mouse_wheel_delta: usize,
    pub mouse_click_enabled: bool,
    /* private fields */
}

Table model for displaying tabular data with keyboard navigation.

Fields

key_map: KeyMap

Key bindings for navigation.

styles: Styles

Styles for rendering.

mouse_wheel_enabled: bool

Whether mouse wheel scrolling is enabled.

mouse_wheel_delta: usize

Number of rows to scroll per mouse wheel tick.

mouse_click_enabled: bool

Whether mouse click selection is enabled.

Implementations

impl Table

pub fn new() -> Self

Creates a new empty table.

pub fn columns(self, columns: Vec<Column>) -> Self

Sets the columns (builder pattern).

pub fn rows(self, rows: Vec<Row>) -> Self

Sets the rows (builder pattern).

pub fn height(self, h: usize) -> Self

Sets the height (builder pattern).

pub fn width(self, w: usize) -> Self

Sets the width (builder pattern).

pub fn focused(self, f: bool) -> Self

Sets the focused state (builder pattern).

pub fn with_styles(self, styles: Styles) -> Self

Sets the styles (builder pattern).

pub fn with_key_map(self, key_map: KeyMap) -> Self

Sets the key map (builder pattern).

pub fn mouse_wheel(self, enabled: bool) -> Self

Enables or disables mouse wheel scrolling (builder pattern).

pub fn mouse_wheel_delta(self, delta: usize) -> Self

Sets the number of rows to scroll per mouse wheel tick (builder pattern).

pub fn mouse_click(self, enabled: bool) -> Self

Enables or disables mouse click row selection (builder pattern).

pub fn is_focused(&self) -> bool

Returns whether the table is focused.

pub fn focus(&mut self)

Focuses the table.

pub fn blur(&mut self)

Blurs (unfocuses) the table.

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

Returns the columns.

pub fn get_rows(&self) -> &[Row]

Returns the rows.

pub fn set_columns(&mut self, columns: Vec<Column>)

Sets the columns.

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

Sets the rows.

pub fn set_width(&mut self, w: usize)

Sets the width.

pub fn set_height(&mut self, h: usize)

Sets the height.

pub fn get_height(&self) -> usize

Returns the viewport height.

pub fn get_width(&self) -> usize

Returns the viewport width.

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

Returns the currently selected row, if any.

pub fn cursor(&self) -> usize

Returns the cursor position (selected row index).

pub fn set_cursor(&mut self, n: usize)

Sets the cursor position.

pub fn move_up(&mut self, n: usize)

Moves the selection up by n rows.

pub fn move_down(&mut self, n: usize)

Moves the selection down by n rows.

pub fn goto_top(&mut self)

Moves to the first row.

pub fn goto_bottom(&mut self)

Moves to the last row.

pub fn from_values(&mut self, value: &str, separator: &str)

Parses rows from a string value with the given separator.

pub fn update(&mut self, msg: &Message)

Updates the table based on key/mouse input.

pub fn view(&self) -> String

Renders the table.

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

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 Model for Table

fn init(&self) -> Option<Cmd>

Initialize the table.

Tables don’t require initialization commands.

fn update(&mut self, msg: Message) -> Option<Cmd>

Update the table state based on incoming messages.

fn view(&self) -> String

Render the table.