[tuify] API change the return type of select_from_list()

[NadiaIdris]

Note - this is breaking change for existing dependents of this crate. We should have a migration strategy in place for them. Either preserve the existing API and add a new one, instead of this breaking change, or just submit a PR w/ the use of the new API to their repo (eg: ockam).

File: state.rs
https://github.com/r3bl-org/r3bl-open-core/blob/main/tuify/src/state.rs#L23-L49

1. Change selected_items type to be SelectModeResult. Please see below.
2. select_from_list function should return a SelectModeResult and not Option<Vec<String>>.
3. Write tests.

pub struct State {
    /// Does not include the header row.
    pub max_display_height: ChUnit,
    pub max_display_width: ChUnit,
    /// This is not adjusted for
    /// [scroll_offset_row_index](State::scroll_offset_row_index).
    pub raw_caret_row_index: ChUnit,
    pub scroll_offset_row_index: ChUnit,
    pub items: Vec<String>,
    pub selected_items: SelectModeResult,
    pub header: String,
    pub selection_mode: SelectionMode,
}

#[derive(Debug, PartialEq, Eq, Hash, Clone, Default)]
enum SelectModeResult {
    Single(String),
    Multiple(Vec<String>),
    #[default]
    None,
}

Also add support to detect Ctrl+C. The behavior of pressing Ctrl+C is the same as pressing Esc.

• https://github.com/r3bl-org/r3bl-open-core/blob/main/tuify/src/keypress.rs#L29
• https://github.com/r3bl-org/r3bl-open-core/blob/main/tuify/src/keypress.rs#L50
• https://github.com/r3bl-org/r3bl-open-core/blob/main/tuify/src/keypress.rs#L50
• Need to use crossterm to detect Ctrl+C: How to handle CTRL-C? crossterm-rs/crossterm#655

[NadiaIdris]

@Harshil-Jani I removed both of us from this issue for the time being (since we weren't working on this issue immediately) because I wanted to post it to Rust user forum to invite contributors to work on some issues. But my account is still on hold with them and I wasn't able to post them 😀. Trying to get my account "unblocked".

[zoo868e]

Cool, can I give it a shot?

[zoo868e]

Just a quick question: Why is the default value an empty string instead of None?

[NadiaIdris]

Cool, can I give it a shot?

Great! I have assigned you to the issue. Let us know if you need any help on Discord https://discord.com/invite/rkBsNK83.

[NadiaIdris]

Just a quick question: Why is the default value an empty string instead of None?

@zoo868e You are correct. The default should be None 👍🏼