Skip to main content

MultiSelect

Struct MultiSelect 

Source
pub struct MultiSelect;
Expand description

A component that displays a multi-select checkbox list.

§Examples

let items = vec!["Option 1", "Option 2", "Option 3"];
let props = MultiSelectProps::new(items)
    .cursor(state.cursor)
    .selected(state.selected.clone())
    .selected_color(Color::Green);

// Handle input in your event loop:
match key.code {
    KeyCode::Up => state.up(),
    KeyCode::Down => state.down(),
    KeyCode::Char(' ') => state.toggle(),
    KeyCode::Char('a') if key.modifiers.contains(KeyModifiers::CONTROL) => state.select_all(),
    KeyCode::Enter => return Some(state.selected_indices()),
    _ => {}
}

Trait Implementations§

Source§

impl Component for MultiSelect

Source§

type Props = MultiSelectProps

The type of properties this component accepts.
Source§

fn render(props: &Self::Props) -> Element

Render this component with the given props, returning an Element tree.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.