Struct Jump 

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

One fuzzy box over several sources, the results grouped by source. Returns a Jumped.

Implementations

impl<T> Jump<T>

pub fn new(prompt: impl Into<String>) -> Jump<T>

pub fn index(self, index: JumpIndex<T>) -> Self

Search index.

pub fn source(self, source: JumpSource<T>) -> Self

Add source to the index.

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

Start with query typed.

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

Show at most rows rows of results, titles included (default 12).

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

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

Rows the preview takes when it is below the list (default 8).

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

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

Report the mouse (#476): a click focuses a result and a second one picks it, a click on a group’s title narrows to it.

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

Make keys do action (see jump_keymap) here only.

pub fn search_index(&self) -> &JumpIndex<T>

pub fn query_text(&self) -> &str

What is typed.

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

The source searched alone, by a prefix typed or by Tab.

pub fn focused(&self) -> Option<(usize, usize)>

The focused result: (source, item).

pub fn result_count(&self) -> usize

How many results are listed.

Trait Implementations

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

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

The best match for the query it started with; none with nothing typed.

type Output = Jumped<T>

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