Skip to main content

Crate txtview

Crate txtview 

Source
Expand description

A minimal, crossterm-based terminal text viewer for Rust.

Wrap any text with TxtView::new, optionally tune it with TxtViewConfig, then call TxtView::run. The viewer takes over the terminal with an alternate screen, switches to raw mode, and restores the previous screen and settings when the user quits.

TxtView::run blocks for the whole session and requires an interactive terminal, so a small program is all it takes:

let mut viewer = TxtView::new("hello world");
viewer.run()

§Styled text

ANSI colors and styling pass through unchanged: SGR codes and OSC8 hyperlinks are preserved, and the active style is re-emitted compactly when a styled line wraps. Control bytes and other escape sequences are shown as visible caret notation. Build styled lines with crossterm’s style module and feed them straight into TxtView::new.

§Configuration

TxtViewConfig controls the display: line numbers, the help bar, the interactive scrollbar, and a fixed viewport size. Configure it with a struct literal plus ..TxtViewConfig::default(), or chain the with_* setters. See its documentation for examples.

Structs§

TxtView
A terminal text viewer.
TxtViewConfig
Options for a TxtView.