Crate ratatui_termwiz

Crate ratatui_termwiz 

Source
Expand description

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

§Crate Organization

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

When to use ratatui-termwiz:

  • You need fine-grained control over dependencies
  • Building a widget library that needs backend functionality
  • You want to use only the Termwiz backend without other backends
  • You need Termwiz’s advanced terminal capabilities

When to use the main ratatui crate:

  • Building applications (recommended - includes termwiz 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 termwiz dependency
  • underline-color — Enables the backend code that sets the underline color. Underline color is not supported on Windows 7.
  • scrolling-regions — Use terminal scrolling regions to make Terminal::insert_before less prone to flickering.

Re-exports§

pub use termwiz;

Structs§

TermwizBackend
A Backend implementation that uses Termwiz to render to the terminal.

Traits§

FromTermwiz
A trait for converting types from Termwiz to Ratatui.
IntoTermwiz
A trait for converting types from Ratatui to Termwiz.