Struct ListState 

pub struct ListState {
    pub selected: usize,
    pub total: usize,
    pub scroll_offset: usize,
}

Base state for simple list navigation.

Can be embedded in more complex state structs to provide common navigation functionality.

Fields

selected: usize

total: usize

scroll_offset: usize

Implementations

impl ListState

pub fn new() -> Self

pub const fn with_total(total: usize) -> Self

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() -> ListState

Returns the “default value” for a type.

impl ListNavigation for ListState

fn selected(&self) -> usize

Get the current selection index.

fn set_selected(&mut self, idx: usize)

Set the selection index.

fn total(&self) -> usize

Get the total number of items.

fn set_total(&mut self, total: usize)

Set the total number of items.

fn select_next(&mut self)

Move selection to the next item.

fn select_prev(&mut self)

Move selection to the previous item.

fn clamp_selection(&mut self)

Ensure selection is within valid bounds.

fn page_up(&mut self)

Move selection up by a page.

fn page_down(&mut self)

Move selection down by a page.

fn go_first(&mut self)

Move to the first item.

fn go_last(&mut self)

Move to the last item.