Skip to content

Commit 51f74ba

Browse files
committed
Add documentation for multiselect
1 parent 60b6188 commit 51f74ba

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/prompts/multi_select.rs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@ use crate::theme::{SimpleTheme, TermThemeRenderer, Theme};
55
use console::{Key, Term};
66

77
/// Renders a multi select prompt.
8+
///
9+
/// ## Example usage
10+
/// ```rust,no_run
11+
/// use dialoguer::MultiSelect;
12+
///
13+
/// let items = vec![("Option 1", true), ("Option 2", false)];
14+
/// let chosen : Vec<usize> = MultiSelect::new()
15+
/// .items_checked(&items)
16+
/// .interact()?;
17+
/// ```
818
pub struct MultiSelect<'a> {
919
defaults: Vec<bool>,
1020
items: Vec<String>,

0 commit comments

Comments
 (0)