Lib.rs

Cargo Features

[dependencies]
tuirealm = { version = "1.9.2", default-features = false, features = ["derive", "serialize", "tui", "crossterm", "termion", "ratatui", "with-crossterm", "with-termion"] }

default = crossterm, derive, ratatui

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

derive default = tuirealm_derive

serialize = serde

Enables serde of bitflags

tui with-crossterm? with-termion?

Enables tui

Affects crossterm::Frame, termion::Frame…

crossterm default with-crossterm?

Enables crossterm and crossterm of optional ratatui and optional tui

ratatui:

Generally an application will only use one backend, so you should only enable one of the following features: enables the CrosstermBackend backend and adds a dependency on the [Crossterm crate].

Affects adapter::crossterm…

termion with-termion?

Enables termion ^2, termion of optional tui and termion of optional ratatui

ratatui:

enables the TermionBackend backend and adds a dependency on the [Termion crate].

Affects adapter::termion…

ratatui default

Enables ratatui

Affects crossterm::Frame, termion::Frame…

with-crossterm = crossterm, tui

deprecated aliases for broken out backend and UI library features

with-termion = termion, tui

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

serde serialize?

tuirealm_derive derive