Struct dialoguer::Checkboxes

pub struct Checkboxes<'a> { /* private fields */ }

Renders a multi select checkbox menu.

Implementations

impl<'a> Checkboxes<'a>

pub fn new() -> Checkboxes<'static>

Creates a new checkbox object.

pub fn with_theme(theme: &'a dyn Theme) -> Checkboxes<'a>

Sets a theme other than the default one.

pub fn clear(&mut self, val: bool) -> &mut Checkboxes<'a>

Sets the clear behavior of the checkbox menu.

The default is to clear the checkbox menu.

pub fn item(&mut self, item: &str) -> &mut Checkboxes<'a>

Add a single item to the selector.

pub fn items(&mut self, items: &[&str]) -> &mut Checkboxes<'a>

Adds multiple items to the selector.

pub fn with_prompt(&mut self, prompt: &str) -> &mut Checkboxes<'a>

Prefaces the menu with a prompt.

When a prompt is set the system also prints out a confirmation after the selection.

pub fn interact(&self) -> Result<Vec<usize>>

Enables user interaction and returns the result.

The user can select the items with the space bar and on enter the selected items will be returned.

pub fn interact_on(&self, term: &Term) -> Result<Vec<usize>>

Like interact but allows a specific terminal to be set.