Struct MultiSelect 

pub struct MultiSelect<T: Clone + PartialEq + Send + Sync + 'static> { /* private fields */ }

A multi-select field for choosing multiple options from a list.

Implementations

impl<T: Clone + PartialEq + Send + Sync + Default + 'static> MultiSelect<T>

pub fn new() -> Self

Creates a new multi-select field.

pub fn key(self, key: impl Into<String>) -> Self

Sets the field key.

pub fn options(self, options: Vec<SelectOption<T>>) -> Self

Sets the options.

pub fn title(self, title: impl Into<String>) -> Self

Sets the title.

pub fn description(self, description: impl Into<String>) -> Self

Sets the description.

pub fn validate(self, validate: fn(&[T]) -> Option<String>) -> Self

Sets the validation function.

pub fn height_options(self, height: usize) -> Self

Sets the visible height (number of options shown).

pub fn limit(self, limit: usize) -> Self

Sets the maximum number of selections allowed.

pub fn filterable(self, enabled: bool) -> Self

Enables or disables filtering mode.

When enabled, pressing ‘/’ enters filter mode where typing filters options.

pub fn get_selected_values(&self) -> Vec<&T>

Gets the currently selected values.

pub fn id(&self) -> usize

Returns the field ID.

Trait Implementations

impl<T: Clone + PartialEq + Send + Sync + Default + 'static> Default for MultiSelect<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Clone + PartialEq + Send + Sync + Default + 'static> Field for MultiSelect<T>

fn get_key(&self) -> &str

Returns the field’s key.

fn get_value(&self) -> Box<dyn Any>

Returns the field’s value.

fn error(&self) -> Option<&str>

Returns the current validation error, if any.

fn init(&mut self) -> Option<Cmd>

Initializes the field.

fn update(&mut self, msg: &Message) -> Option<Cmd>

Updates the field with a message.

fn view(&self) -> String

Renders the field.

fn focus(&mut self) -> Option<Cmd>

Focuses the field.

fn blur(&mut self) -> Option<Cmd>

Blurs the field.

fn key_binds(&self) -> Vec<Binding>

Returns the help keybindings.

fn with_theme(&mut self, theme: &Theme)

Sets the theme.

fn with_keymap(&mut self, keymap: &KeyMap)

Sets the keymap.

fn with_width(&mut self, width: usize)

Sets the width.

fn with_height(&mut self, height: usize)

Sets the height.

fn with_position(&mut self, position: FieldPosition)

Sets the field position.

fn skip(&self) -> bool

Returns whether this field should be skipped.

fn zoom(&self) -> bool

Returns whether this field should zoom (take full height).