Struct ListState 

pub struct ListState {
    pub selected: Option<usize>,
    /* private fields */
}

Fields

selected: Option<usize>

The selected item. If None, no item is currently selected.

Implementations

impl ListState

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

👎Deprecated since 0.9.0: Use ListState’s selected field instead.

Returns the index of the currently selected item, if any.

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

Selects an item by its index.

pub fn next(&mut self)

Selects the next element of the list. If circular is true, calling next on the last element selects the first.

Example

use tui_widget_list::ListState;

let mut list_state = ListState::default();
list_state.next();

pub fn previous(&mut self)

Selects the previous element of the list. If circular is true, calling previous on the first element selects the last.

Example

use tui_widget_list::ListState;

let mut list_state = ListState::default();
list_state.previous();

pub fn scroll_offset_index(&self) -> usize

Returns the index of the first item currently displayed on the screen.

pub fn scroll_truncation(&self) -> u16

Returns the number of rows/columns of the first visible item that are scrolled off the top/left.

When the first visible item is partially scrolled out of view, this returns how many rows (for vertical lists) or columns (for horizontal lists) are hidden above/left of the viewport. Returns 0 if the first visible item is fully visible.

Example

If message #5 is the first visible item but its first 2 rows are scrolled off the top, this returns 2. Combined with scroll_offset_index(), you can calculate the exact scroll position in pixels/rows.

Trait Implementations

impl Clone for ListState

fn clone(&self) -> ListState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListState

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

Formats the value using the given formatter.

impl Default for ListState

fn default() -> Self

Returns the “default value” for a type.