Struct inquire::MultiSelect

pub struct MultiSelect<'a, T> {
    pub message: &'a str,
    pub options: Vec<T>,
    pub default: Option<&'a [usize]>,
    pub help_message: Option<&'a str>,
    pub page_size: usize,
    pub vim_mode: bool,
    pub starting_cursor: usize,
    pub filter: Filter<'a, T>,
    pub keep_filter: bool,
    pub formatter: MultiOptionFormatter<'a, T>,
    pub validator: Option<MultiOptionValidator<'a, T>>,
    pub render_config: &'a RenderConfig,
}

Prompt suitable for when you need the user to select many options (including none if applicable) among a list of them.

The user can select (or deselect) the current highlighted option by pressing space, clean all selections by pressing the left arrow and select all options by pressing the right arrow.

This prompt requires a prompt message and a non-empty Vec of options to be displayed to the user. The options can be of any type as long as they implement the Display trait. It is required that the Vec is moved to the prompt, as the prompt will return the ownership of the Vec after the user submits, with only the selected options inside it.

• If the list is empty, the prompt operation will fail with an InquireError::InvalidConfiguration error.

The options are paginated in order to provide a smooth experience to the user, with the default page size being 7. The user can move from the options and the pages will be updated accordingly, including moving from the last to the first options (or vice-versa).

Customizable options:

• Prompt message: Required when creating the prompt.
• Options list: Options displayed to the user. Must be non-empty.
• Default selections: Options that are selected by default when the prompt is first rendered. The user can unselect them. If any of the indices is out-of-range of the option list, the prompt will fail with an InquireError::InvalidConfiguration error.
• Starting cursor: Index of the cursor when the prompt is first rendered. Default is 0 (first option). If the index is out-of-range of the option list, the prompt will fail with an InquireError::InvalidConfiguration error.
• Help message: Message displayed at the line below the prompt.
• Formatter: Custom formatter in case you need to pre-process the user input before showing it as the final answer.
  • Prints the selected options string value, joined using a comma as the separator, by default.
• Validator: Custom validator to make sure a given submitted input pass the specified requirements, e.g. not allowing 0 selected options or limiting the number of options that the user is allowed to select.
  • No validators are on by default.
• Page size: Number of options displayed at once, 7 by default.
• Filter function: Function that defines if an option is displayed or not based on the current filter input.
• Keep filter flag: Whether the current filter input should be cleared or not after a selection is made. Defaults to true.

Example

For a full-featured example, check the GitHub repository.

Fields

message: &'a str

Message to be presented to the user.

options: Vec<T>

Options displayed to the user.

default: Option<&'a [usize]>

Default indexes of options to be selected from the start.

help_message: Option<&'a str>

Help message to be presented to the user.

page_size: usize

Page size of the options displayed to the user.

vim_mode: bool

Whether vim mode is enabled. When enabled, the user can navigate through the options using hjkl.

starting_cursor: usize

Starting cursor index of the selection.

filter: Filter<'a, T>

Function called with the current user input to filter the provided options.

keep_filter: bool

Whether the current filter typed by the user is kept or cleaned after a selection is made.

formatter: MultiOptionFormatter<'a, T>

Function that formats the user input and presents it to the user as the final rendering of the prompt.

validator: Option<MultiOptionValidator<'a, T>>

Validator to apply to the user input.

In case of error, the message is displayed one line above the prompt.

render_config: &'a RenderConfig

RenderConfig to apply to the rendered interface.

Implementations

impl<'a, T> MultiSelect<'a, T> where
    T: Display, 

pub const DEFAULT_FORMATTER: MultiOptionFormatter<'a, T>

String formatter used by default in MultiSelect prompts. Prints the string value of all selected options, separated by commas.

Examples

use inquire::list_option::ListOption;
use inquire::MultiSelect;

let formatter = MultiSelect::<&str>::DEFAULT_FORMATTER;

let mut ans = vec![ListOption::new(0, &"New York")];
assert_eq!(String::from("New York"), formatter(&ans));

ans.push(ListOption::new(3, &"Seattle"));
assert_eq!(String::from("New York, Seattle"), formatter(&ans));

ans.push(ListOption::new(7, &"Vancouver"));
assert_eq!(String::from("New York, Seattle, Vancouver"), formatter(&ans));

pub const DEFAULT_FILTER: Filter<'a, T>

Default filter function, which checks if the current filter value is a substring of the option value. If it is, the option is displayed.

Examples

use inquire::MultiSelect;

let filter = MultiSelect::<&str>::DEFAULT_FILTER;
assert_eq!(false, filter("sa", &"New York",      "New York",      0));
assert_eq!(true,  filter("sa", &"Sacramento",    "Sacramento",    1));
assert_eq!(true,  filter("sa", &"Kansas",        "Kansas",        2));
assert_eq!(true,  filter("sa", &"Mesa",          "Mesa",          3));
assert_eq!(false, filter("sa", &"Phoenix",       "Phoenix",       4));
assert_eq!(false, filter("sa", &"Philadelphia",  "Philadelphia",  5));
assert_eq!(true,  filter("sa", &"San Antonio",   "San Antonio",   6));
assert_eq!(true,  filter("sa", &"San Diego",     "San Diego",     7));
assert_eq!(false, filter("sa", &"Dallas",        "Dallas",        8));
assert_eq!(true,  filter("sa", &"San Francisco", "San Francisco", 9));
assert_eq!(false, filter("sa", &"Austin",        "Austin",       10));
assert_eq!(false, filter("sa", &"Jacksonville",  "Jacksonville", 11));
assert_eq!(true,  filter("sa", &"San Jose",      "San Jose",     12));

pub const DEFAULT_PAGE_SIZE: usize

Default page size, equal to the global default page size config::DEFAULT_PAGE_SIZE

pub const DEFAULT_VIM_MODE: bool

Default value of vim mode, equal to the global default value config::DEFAULT_PAGE_SIZE

pub const DEFAULT_STARTING_CURSOR: usize

Default starting cursor index.

pub const DEFAULT_KEEP_FILTER: bool

Default behavior of keeping or cleaning the current filter value.

pub const DEFAULT_HELP_MESSAGE: Option<&'a str>

Default help message.

pub fn new(message: &'a str, options: Vec<T>) -> Self

Creates a MultiSelect with the provided message and options, along with default configuration values.

pub fn with_help_message(self, message: &'a str) -> Self

Sets the help message of the prompt.

pub fn without_help_message(self) -> Self

Removes the set help message.

pub fn with_page_size(self, page_size: usize) -> Self

Sets the page size.

pub fn with_vim_mode(self, vim_mode: bool) -> Self

Enables or disabled vim_mode.

pub fn with_keep_filter(self, keep_filter: bool) -> Self

Sets the keep filter behavior.

pub fn with_filter(self, filter: Filter<'a, T>) -> Self

Sets the filter function.

pub fn with_formatter(self, formatter: MultiOptionFormatter<'a, T>) -> Self

Sets the formatter.

pub fn with_validator(self, validator: MultiOptionValidator<'a, T>) -> Self

Sets the validator to apply to the user input. You might want to use this feature in case you need to limit the user to specific choices, such as limiting the number of selections.

In case of error, the message is displayed one line above the prompt.

pub fn with_default(self, default: &'a [usize]) -> Self

Sets the indexes to be selected by the default.

pub fn with_starting_cursor(self, starting_cursor: usize) -> Self

Sets the starting cursor index.

pub fn with_render_config(self, render_config: &'a RenderConfig) -> Self

Sets the provided color theme to this prompt.

pub fn prompt(self) -> InquireResult<Vec<T>>

Parses the provided behavioral and rendering options and prompts the CLI user for input according to the defined rules.

Returns the owned object selected by the user.

pub fn raw_prompt(self) -> InquireResult<Vec<ListOption<T>>>

Parses the provided behavioral and rendering options and prompts the CLI user for input according to the defined rules.

Returns a ListOption containing the index of the selection and the owned object selected by the user.

Trait Implementations

impl<'a, T: Clone> Clone for MultiSelect<'a, T>

fn clone(&self) -> MultiSelect<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.