Struct TableSelect 

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

Pick a row of a table: columns aligned under their headings, rows filtered by any cell. Returns the row’s value.

Ctrl+Y copies the focused row, and Alt+Y its focused cell, to the terminal’s clipboard (#434): as text (cells separated by tabs), CSV or JSON (an object keyed by the headings), cycled with Alt+F or set with copy_format. Ctrl+Right and Ctrl+Left move the focused column, which the headings underline.

With scroll_x, a table wider than its list scrolls across (#717): Left and Right move a column at a time, Shift+Home and Shift+End go to the ends, Shift with the wheel scrolls, and the view follows the focused column. ‹ and › at the ends of the headings say that columns are out of view on that side. freeze_columns keeps leading columns in place.

Implementations

impl<T> TableSelect<T>

pub fn new<H, S, R, V>( prompt: impl Into<String>, headers: H, rows: R, ) -> TableSelect<T>

where H: IntoIterator<Item = S>, S: Into<String>, R: IntoIterator<Item = (V, Vec<String>)>, V: Into<Item<T>>,

A table of rows, each an item (its value, actions, preview) and its cells, under headers.

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

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

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

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

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

Start with this filter text.

pub fn default(self, index: usize) -> Self

The row returned without a terminal, and focused first.

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

Actions offered on every row, beside each row’s own.

pub fn menu_key(self, key: Key) -> Self

The key that opens the action menu (default Ctrl+K).

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

Report the mouse: see Select::with_mouse.

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

The id of the action that picked the row, if one did.

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

pub fn select(&self) -> &Select<T>

The underlying list.

pub fn set_icons(&mut self, icons: Vec<Option<Text>>)

An icon before each row’s label, by item index: see Select::set_icons.

pub fn copy_format(self, format: CopyFormat) -> Self

How Ctrl+Y and Alt+Y copy (default: text).

pub fn column(&self) -> Option<usize>

The focused column, once one has been moved to.

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

Scroll across when the table is wider than its list (#717), rather than cutting it at the right edge: see the type’s keys.

pub fn freeze_columns(self, columns: usize) -> Self

Keep the first columns columns in place while the rest scroll across; turns scroll_x on.

pub fn first_column(&self) -> usize

The first column in view after the frozen ones, as of the last render.

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

Make keys do action (see table_keymap) on this table only.

Trait Implementations

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

type Output = T

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 handle(&mut self, event: &Event, context: &Context<'_>) -> Flow<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 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<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<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.