Struct Pager 

pub struct Pager { /* private fields */ }

Pages content; returns when closed.

Implementations

impl Pager

pub fn new(renderable: impl Renderable + Send + Sync + 'static) -> Pager

Page renderable, rendered at the terminal’s width.

pub fn lines(lines: Vec<Vec<Segment>>) -> Pager

Page lines already rendered.

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

Make keys do action (see pager_keymap and pager_search_keymap) on this pager only; no keys unbinds it.

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

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

Report the mouse (#476): the wheel scrolls, and a click on a link (an OSC 8 hyperlink in the content) records it: see Pager::links. The pager never opens a link itself.

pub fn links(&self) -> &[String]

The links clicked while paging, in order: for the caller to open, print or ignore.

pub fn sticky_header(self, lines: usize) -> Self

Keep the first lines lines on top while the rest scroll (#716): a header rendered with the content.

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

Keep a table’s header on top while its rows scroll (#716), when the content starts with a table: its title, top edge and header rows, down to the line under the header, as table_header_rows finds them at each width. Content that does not start with a table scrolls as it is.

pub fn sticky_rows(&self) -> usize

The lines that stay on top now.

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

Start with this search.

Trait Implementations

impl Component for Pager

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

Render the content at the terminal’s width and, for a search given up front, show its first match.

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

Without a terminal, there is nothing to page: write it all.

type Output = ()

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

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

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

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

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.