Struct MultiSelect 

pub struct MultiSelect<T>(/* private fields */);

A fuzzy multiple choice: Tab marks items (Shift+Tab marks and moves up, Ctrl+A marks every match), Enter returns the marked items in list order, or the focused one when none is marked.

Implementations

impl<T> MultiSelect<T>

pub fn new<I, V>(prompt: impl Into<String>, items: I) -> MultiSelect<T>

where I: IntoIterator<Item = V>, V: Into<Item<T>>,

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

pub fn preview(self, layout: PreviewLayout) -> Self

pub fn theme(self, theme: Theme) -> Self

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

pub fn repaint_every(self, interval: Duration) -> Self

See Select::repaint_every.

pub fn actions(self, actions: Actions) -> Self

See Select::actions.

pub fn with_mouse(self, on: bool) -> Self

See Select::with_mouse.

pub fn reload_on( self, key: Key, source: impl FnMut() -> Vec<Item<T>> + Send + 'static, ) -> Self

See Select::reload_on: marks stay with their items.

pub fn reload_from(self, feed: Receiver<Vec<Item<T>>>) -> Self

See Select::reload_from.

pub fn reload(&mut self, items: Vec<Item<T>>)

Replace the items, keeping the query, the focus and the marks: see Select::reload.

pub fn marked(self, indices: impl IntoIterator<Item = usize>) -> Self

Mark these items to begin with; they are also the default without a terminal.

pub fn action(&self) -> Option<&str>

pub fn items(&self) -> &[Item<T>]

Trait Implementations

impl<T: Clone> Component for MultiSelect<T>

type Output = Vec<T>

fn handle(&mut self, event: &Event, context: &Context<'_>) -> Flow<Vec<T>>

Handle one event. Ctrl+C never arrives here: the event loop ends the component with Outcome::Interrupted.

fn render(&self, context: &Context<'_>) -> View

Render the current state.

fn keymap(&self) -> Keymap

The bindings this component has right now, for a help overlay, a shortcut list or status-bar hints to read (see keymap). A container’s include its focused child’s, before its own. The default declares none.

fn tick(&self) -> Option<Duration>

How often the component wants Event::Tick, for a spinner or a countdown. None (the default): never.

fn mouse(&self) -> bool

Whether the component wants mouse events (#476): clicks, drags and the wheel. Off by default, since reporting the mouse takes text selection away from the terminal; a component turns it on when its caller opts in, and run then enables mouse reporting for the session.

fn default_value(&self) -> Option<Vec<T>>

The value to return when the terminal is not interactive and the policy asks for defaults. None: there is none.

fn prompt( &mut self, io: &mut dyn LineIo, ) -> Result<Option<Vec<T>>, NotInteractive>

Ask for the value line by line, for when the terminal is not interactive and the policy asks for a prompt. The default says the component has no line-based form.

fn start(&mut self, context: &Context<'_>) -> Flow<Self::Output>

Called once, before the component is first painted, with the terminal’s size: for work that needs it, such as rendering content at the width. Returning Done or Cancel finishes the component without waiting for an event. The default does nothing.

fn focusable(&self) -> bool

Whether the component takes focus in a container: Tab stops on it and keys go to it. The default: yes. A label, or a component that has finished, says no.

fn focus_step(&mut self, forward: bool) -> bool

Move focus to the next (forward) or previous focus stop inside this component, for Tab and Shift+Tab. false when there is none after the current one, so the container moves on to its next child. The default, for a component that is one stop: false.

fn focus_enter(&mut self, forward: bool) -> bool

Take focus from outside: at the first stop inside when forward, at the last otherwise. false when nothing in it can take focus. The default: whether the component is focusable.