Skip to main content

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.

Most application authors should start with the main ratatui crate and only depend on ratatui-termwiz directly when they specifically want the Termwiz backend or its advanced terminal capabilities. This crate is the backend layer, not the primary docs.rs entry point for building applications.

§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 want to depend on the Termwiz backend crate directly
  • You need Termwiz’s advanced terminal capabilities

When to use the main ratatui crate:

  • Building applications
  • You want backend selection to stay behind Ratatui’s re-exports

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.