Lib.rs

Cargo Features

[dependencies]
ratatui-crossterm = { version = "0.1.1", default-features = false, features = ["crossterm_0_28", "crossterm_0_29", "serde", "underline-color", "scrolling-regions", "unstable", "unstable-backend-writer", "document-features"] }

default = crossterm_0_29, underline-color

These default features are set whenever ratatui-crossterm is added without default-features = false somewhere in the dependency tree.

crossterm_0_28

One of the following versions of crossterm must be enabled. By default, the latest version is enabled. This will always default to the most recent version of crossterm, but you can override this by specifying the version you want to use in your Cargo.toml file. The purpose of these features is to allow widget libraries to depend on specific versions of crossterm in a way that doesn't cause version conflicts. A compiler error will be raised if you don't enable at least one of the following features.

Enables crossterm 0.28.x

Enables crossterm ^0.28

crossterm_0_29 default

Enables crossterm 0.29.x

Enables crossterm

serde

The following features are optional and can be enabled to add additional functionality to the library. These features are not required for the library to function, but they may be useful in certain situations.

Enables serde for crossterm dependency

Enables serde of optional crossterm ^0.28 and optional crossterm

underline-color default

enables the backend code that sets the underline color.
Underline color is not supported on Windows 7.

Enables underline-color of ratatui-core

scrolling-regions

Use terminal scrolling regions to make Terminal::insert_before less prone to flickering.

Enables scrolling-regions of ratatui-core

unstable = unstable-backend-writer

The following features are unstable and may change in the future:

Enable all unstable features.

unstable-backend-writer unstable?

Enables getting access to backends' writers.

Features from optional dependencies

document-features implicit feature

Enables document-features

document-features:

Extract documentation for the feature flags from comments in Cargo.toml