Struct Reorder 

pub struct Reorder<T> { /* private fields */ }

A list put in order by the user. Returns the items’ values in the new order; order has it as the items’ first indices.

use rich_interact::headless::{self, Script};
use rich_interact::{Outcome, Reorder};

let reorder = Reorder::new("Priority", ["alpha", "beta", "gamma"]);
// Focus gamma, carry it to the top, done.
let script = Script::new().keys("down down alt+up alt+up enter");
let (outcome, _) = headless::run(reorder, script, 40, 8);
assert_eq!(outcome.unwrap(), Outcome::Done(vec!["gamma", "alpha", "beta"]));

Implementations

impl<T> Reorder<T>

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

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

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

Show at most rows items at once (default 10).

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

pub fn focus(self, position: usize) -> Self

Focus this position first.

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

Report the mouse (#476): a press focuses a row and a drag carries it.

pub fn rebind(self, action: &str, keys: impl IntoIterator<Item = Key>) -> Self

Make keys do action (see reorder_keymap) on this list only; no keys unbinds it.

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

pub fn order(&self) -> &[usize]

The order so far, as the items’ indices when the list was made: [2, 0, 1] once the third item was moved to the top.

pub fn cursor(&self) -> usize

The focused position.

pub fn is_grabbed(&self) -> bool

Whether an item is grabbed (Space) and moves with the arrows.

Trait Implementations

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

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

The order as it stands: without a terminal and asked for defaults, nothing moves.

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 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 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 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 tick(&self) -> Option<Duration>

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

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.