[go: up one dir, main page]

Crate ratatui_termion

Source
Expand description

This module provides the TermionBackend implementation for the Backend trait. It uses the Termion crate to interact with the terminal.

§Crate Organization

ratatui-termion is part of the Ratatui workspace that was modularized in version 0.30.0. This crate provides the Termion backend implementation for Ratatui.

When to use ratatui-termion:

  • You need fine-grained control over dependencies
  • Building a widget library that needs backend functionality
  • You want to use only the Termion backend without other backends
  • You prefer Termion’s Unix-focused approach

When to use the main ratatui crate:

  • Building applications (recommended - includes termion backend when enabled)
  • You want the convenience of having everything available

For detailed information about the workspace organization, see ARCHITECTURE.md.

§Features

  • serde — Enables serde for termion dependency
  • scrolling-regions — Use terminal scrolling regions to make Terminal::insert_before less prone to flickering.
  • unstable — Enables all unstable features.
  • unstable-backend-writer — Enables getting access to backends’ writer.

Re-exports§

pub use termion;

Structs§

ResetRegion
Reset scrolling region.
SetRegion
Set scrolling region.
TermionBackend
A Backend implementation that uses Termion to render to the terminal.

Traits§

FromTermion
A trait for converting a Termion type to a Ratatui type.
IntoTermion
A trait for converting a Ratatui type to a Termion type.