Add .next()/.prev() to ListState to make traversing a list of selectable items easier

[sparky8251]

Problem

When using a ListState to display selectable items in a TUI, there is no easy way to advance the selection right now requiring a wrapper struct to handle it currently.

Solution

As an example, this is the wrapper code I've been using

#[derive(Debug, Default)]
pub struct StatefulList<T> {
    state: ListState,
    items: Vec<T>,
}

impl<T> StatefulList<T> {
    pub fn with_items(items: Vec<T>) -> Self {
        Self {
            state: ListState::default(),
            items,
        }
    }
    pub fn next(&mut self) {
        let i = match self.state.selected() {
            Some(i) => {
                if i >= self.items.len() - 1 {
                    0
                } else {
                    i + 1
                }
            }
            None => 0,
        };
        self.state.select(Some(i));
    }
    pub fn previous(&mut self) {
        let i = match self.state.selected() {
            Some(i) => {
                if i == 0 {
                    self.items.len() - 1
                } else {
                    i - 1
                }
            }
            None => 0,
        };
        self.state.select(Some(i));
    }
}

But if ListState just had .next()/.prev() implemented on it, I wouldn't need this code at all.

Additional context

It's likely other stateful widgets that are often used to make selectable "lists" would benefit from similar functions, but I'm not sure which ones exist and are missing them as of right now.

[hexavik]

Hi, can I take this?

[orhun]

@hexavik you got it!

[hexavik]

Thanks, I shall start working on this from Monday.

[joshka]

Already in flight - https://github.com/ratatui-org/ratatui/pull/1159