Struct Multiselect 

pub struct Multiselect<T> { /* private fields */ }

Prompt that allows to select multiple options from the given list. Supports filtering and moving the selection with arrow keys.

use cli_prompts::{
    prompts::{Multiselect, AbortReason},
    DisplayPrompt,
};

fn main() {
    let files = [
        "hello.txt",
        "image.jpg",
        "music.mp3",
        "document.pdf"
    ];

    let prompt = Multiselect::new("Select files to copy", files.into_iter())
                    .dont_display_help_message()
                    .max_displayed_options(3);
    let selection : Result<Vec<&str>, AbortReason> = prompt.display();
    match selection {
        Ok(selected_files) => {
            for file in selected_files {
                // Copy the file
            }
        },
        Err(abort_reason) => println!("Prompt is aborted because of {:?}", abort_reason),
    }
}

Implementations

impl<T> Multiselect<T>

where T: Into<String> + Clone,

pub fn new<S, I>(label: S, options: I) -> Self

where S: Into<String>, I: Iterator<Item = T>,

Create new prompt with the given label and the iterator over a type that is convertable to String

Examples found in repository

examples/general.rs (line 50)

fn main() {
    let desserts = [
        "Tiramisu",
        "Cheesecake",
        "Brownee",
        "Cookie",
        "Jelly",
        "Chupa-Chups",
        "Pudding",
    ];
    let subjects = [
        "Physics",
        "Math",
        "Polish",
        "English",
        "Sport",
        "Geography",
        "History",
    ];
    let cars = [CarModel::Audi, CarModel::BMW, CarModel::Chevrolet];

    let input_prompt = Input::new("Enter your name", |s| Ok(s.to_string()))
        .default_value("John")
        .help_message("Please provide your real name");
    let confirmation = Confirmation::new("Do you want a cup of coffee?").default_positive(true);
    let dessert_selection = Selection::new("Your favoite dessert", desserts.into_iter());
    let car_selection =
        Selection::new_with_transformation("Your car model", cars.into_iter(), car_to_string);
    let subjects_selection =
        Multiselect::new("What are your favourite subjects", subjects.into_iter());

    let name = input_prompt.display();
    let is_coffee = confirmation.display();
    let dessert = dessert_selection.display();
    let car = car_selection.display();
    let subjects = subjects_selection.display();

    println!("Name: {:?}", name);
    println!("Is coffee: {:?}", is_coffee);
    println!("Dessert: {:?}", dessert);
    println!("Car: {:?}", car);
    println!("Subjects: {:?}", subjects);
}

impl<T> Multiselect<T>

pub fn new_transformed<S, I, F>(label: S, options: I, transformation: F) -> Self

where S: Into<String>, I: Iterator<Item = T>, F: Fn(&T) -> String,

Create new prompt with the given label and a transformation function that will convert the iterator items to strings

pub fn help_message<S: Into<String>>(self, message: S) -> Self

Set help message to be displayed after the filter string

pub fn dont_display_help_message(self) -> Self

Makes prompt not to display the help message

pub fn max_displayed_options(self, max_options: u16) -> Self

Sets the maximum number of options that can be displayed on the screen

Trait Implementations

impl<T> MultiOptionPrompt<T> for Multiselect<T>

fn max_options_count(&self) -> u16

Maximum number of options that can be displayed on the screen

fn options(&self) -> &Options<T>

Returns the reference to the Options struct

fn currently_selected_index(&self) -> usize

Get the index of the option on the screen that is currently selected

fn draw_option( &self, option_index: usize, option_label: &str, is_selected: bool, commands: &mut impl CommandBuffer, )

Draws the option with the given index and label

fn draw_header(&self, commands: &mut impl CommandBuffer, is_submitted: bool)

Draws the prompt header

fn draw_multioption( &self, label: &str, is_submitted: bool, label_style: &LabelStyle, cmd_buffer: &mut impl CommandBuffer, )

Draws the entire prompt with all the options. Call this from within the Prompt::draw() method

impl<T> Prompt<Vec<T>> for Multiselect<T>

fn draw(&self, commands: &mut impl CommandBuffer)

Defines how to draw the prompt with a set of commands. The goal of this method is to populate the commands buffer with a set of commands that will draw your prompt to the screen.

fn on_key_pressed(&mut self, key: Key) -> EventOutcome<Vec<T>>

This should handle the keyboard key presses. Should return the outcome of the keypress: